mkdocs/文档完善提示词模板.md

Android Framework文档完善提示词模板

核心原则

1. 文档结构标准

# 文档标题

[简要介绍文档主题和重要性]

## 主题概览

[使用Mermaid图表展示核心概念或流程]

## 1. 核心概念

### 1.1 子主题1
- **关键点1**：详细说明
- **关键点2**：详细说明

### 1.2 子主题2
[代码示例或配置示例]

## 2. 技术实现

### 2.1 实现机制
[详细的技术实现分析]

### 2.2 关键代码
```java
// 关键代码示例
public class Example {
    // 代码实现
}

3. 性能优化

3.1 优化策略

• 策略1：说明
• 策略2：说明

3.2 调试工具

# 调试命令示例
adb logcat -s Tag:I

4. 最佳实践

4.1 设计原则

• 原则1：说明
• 原则2：说明

4.2 常见问题

• 问题1：解决方案
• 问题2：解决方案

总结

[总结文档核心价值和重要性]

### 2. 内容质量标准
- **专业性**：使用准确的技术术语
- **完整性**：覆盖主题的所有重要方面
- **实用性**：包含实际代码示例和最佳实践
- **可读性**：结构清晰，层次分明
- **可维护性**：易于更新和维护

## 具体操作步骤

### 步骤1：分析现有文件
```powershell
# 检查文件状态
cd <目录路径>
Get-ChildItem "*.md" | Format-Table Name, Length, LastWriteTime

# 检查文件内容
Get-Content <文件名> -TotalCount 5 -Encoding UTF8

步骤2：处理编码问题

# 如果文件有编码问题，重新创建
$content = @'
# 文档标题
[完整内容]
'@

[System.IO.File]::WriteAllText("<文件名>", $content, [System.Text.Encoding]::UTF8)

步骤3：完善文档内容

3.1 基础结构

# 文档标题

[主题介绍，说明重要性和应用场景]

## 核心概念
[使用列表或表格说明基本概念]

## 技术实现
[详细的技术分析，包含代码示例]

## 优化策略
[性能优化、内存优化等]

## 调试方法
[调试工具和命令]

## 最佳实践
[开发经验和建议]

## 总结
[核心要点总结]

3.2 高级结构（适合复杂主题）

# 文档标题

## 架构概览
```mermaid
[图表展示整体架构]

1. 基础原理

1.1 核心机制

1.2 关键组件

2. 实现细节

2.1 代码分析

2.2 配置说明

3. 性能优化

3.1 优化方法

3.2 监控工具

4. 问题排查

4.1 常见问题

4.2 解决方案

5. 扩展开发

5.1 定制化方法

5.2 集成指南

总结与展望

### 步骤4：添加代码示例

#### 4.1 Java代码示例
````markdown
```java
// 类定义
public class Example {
    private String mData;
    
    // 方法示例
    public void doSomething() {
        // 实现逻辑
    }
}

#### 4.2 XML配置示例
````markdown
```xml
<!-- 配置示例 -->
<activity
    android:name=".MainActivity"
    android:configChanges="orientation|screenSize">
</activity>
```

4.3 Shell命令示例

```bash
# 调试命令
adb logcat -s ActivityManager:I

# 性能分析
adb shell systrace.py app
```

步骤5：添加图表

5.1 Mermaid流程图

```mermaid
graph TD
    A[开始] --> B[过程1]
    B --> C[过程2]
    C --> D[结束]
```

5.2 Mermaid序列图

```mermaid
sequenceDiagram
    participant A as 组件A
    participant B as 组件B
    A->>B: 请求
    B-->>A: 响应
```

5.3 Mermaid状态图

```mermaid
stateDiagram-v2
    [*] --> State1
    State1 --> State2: 事件
    State2 --> [*]
```

步骤6：验证和测试

6.1 文件验证

# 验证文件创建
if (Test-Path "<文件名>") {
    $fileInfo = Get-Item "<文件名>"
    Write-Host "文件大小: $($fileInfo.Length) 字节"
    
    # 内容验证
    $content = Get-Content "<文件名>" -TotalCount 3 -Encoding UTF8
    $content | ForEach-Object { Write-Host $_ }
}

6.2 编码验证

# 确保UTF-8编码
[System.IO.File]::WriteAllText("<文件名>", $content, [System.Text.Encoding]::UTF8)

具体案例模板

案例：Android组件文档

# [组件名称]深度解析

[组件介绍和重要性说明]

## [组件名称]架构概览

```mermaid
[架构图表]

1. 核心机制

1.1 工作原理

• 机制1：详细说明
• 机制2：详细说明

1.2 生命周期

// 生命周期方法示例
@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    // 初始化逻辑
}

2. 配置与使用

2.1 基本配置

<!-- 配置示例 -->
<component
    android:name=".ComponentName"
    android:enabled="true">
</component>

2.2 高级配置

[高级配置说明]

3. 性能优化

3.1 内存优化

• 策略1：说明
• 策略2：说明

3.2 启动优化

• 策略1：说明
• 策略2：说明

4. 调试与问题排查

4.1 调试工具

# 查看组件日志
adb logcat -s ComponentTag:I

# 分析性能
adb shell dumpsys <service_name>

4.2 常见问题

• 问题1：现象和解决方案
• 问题2：现象和解决方案

5. 最佳实践

5.1 设计原则

• 原则1：说明
• 原则2：说明

5.2 代码规范

[代码编写规范]

总结

[核心价值总结，学习建议]

## 注意事项

### 1. 编码问题处理
- 使用`[System.IO.File]::WriteAllText()`确保UTF-8编码
- 避免使用可能引起编码问题的文本编辑器
- 验证文件编码是否正确

### 2. 内容质量控制
- 确保技术准确性
- 提供实际可用的代码示例
- 包含调试和问题排查方法
- 遵循Android开发最佳实践

### 3. 文档维护
- 保持文档结构一致性
- 定期更新内容
- 添加版本更新日志
- 提供相关资源链接

## 自动化脚本模板

```powershell
# 文档完善自动化脚本
param(
    [string]$DirectoryPath,
    [string]$FileName,
    [string]$DocumentTitle
)

# 切换到目标目录
cd $DirectoryPath

# 检查文件状态
if (Test-Path $FileName) {
    Write-Host "文件已存在，备份原文件..." -ForegroundColor Yellow
    $backupName = "$FileName.backup_$(Get-Date -Format 'yyyyMMdd_HHmmss')"
    Copy-Item $FileName $backupName -Force
}

# 创建文档内容
$content = @"
# $DocumentTitle

[文档介绍内容]

## 核心概念

### 1. 基本概念
- **概念1**：说明
- **概念2**：说明

## 技术实现

### 2.1 实现机制
[技术实现分析]

### 2.2 代码示例
\`\`\`java
// 示例代码
public class Example {
    // 实现
}
\`\`\`

## 最佳实践

### 3.1 开发建议
- 建议1
- 建议2

## 总结

[文档总结]
"@

# 保存文档
try {
    [System.IO.File]::WriteAllText($FileName, $content, [System.Text.Encoding]::UTF8)
    Write-Host "文档创建成功: $FileName" -ForegroundColor Green
    
    # 验证
    if (Test-Path $FileName) {
        $size = (Get-Item $FileName).Length
        Write-Host "文件大小: $size 字节" -ForegroundColor Green
    }
} catch {
    Write-Host "文档创建失败: $_" -ForegroundColor Red
}

使用建议

1. 根据文档类型选择模板：简单主题使用基础结构，复杂主题使用高级结构
2. 确保技术准确性：所有技术内容必须准确无误
3. 提供实用价值：文档应该对开发者有实际帮助
4. 保持一致性：同一项目的文档保持相同风格和结构
5. 定期更新：随着技术发展更新文档内容

通过遵循这个模板，可以高效地创建和完善Android Framework相关文档，确保文档质量和技术价值。