Files
firmware-app-development/references/records.md
T

97 lines
2.5 KiB
Markdown

# 输出模板
以下内容默认只在对话中使用。用户明确要求时才写入项目文档。
输出使用简洁中文。文件名、命令、接口名和日志保留原文。
## 需求确认
```markdown
1. <问题名称>
- 不清楚的地方:<内容>
- 可选做法:<选项>
- 建议:<建议和简短理由>
- 影响:<功能或任务>
```
一次列出当前能确认的全部问题,然后等待用户回答。
## 任务清单
```markdown
| 任务 | 修改范围 | 状态 |
|---|---|---|
| T1 - <名称> | <应用模块和文件> | 待确认 |
```
状态只使用必要的普通中文:
- 待确认
- 开发中
- 代码已完成
- 底层未处理
- 等待用户测试
- 用户已确认
- 受阻
底层修改不放入应用开发任务。需要说明时,单独使用“底层未处理内容”。
## 当前任务方案
```markdown
任务:T1 - <名称>
实现方案:<准备怎样修改应用代码>
```
方案保持简短。用户确认后才能开发。
## 底层未处理内容
```markdown
## <名称>
- 相关应用任务:<任务 ID 和功能>
- 底层内容:<PSP、BSP、驱动、设备树、GPIO/PQ、传感器等>
- 当前情况:<现在是什么状态>
- 需要结果:<底层需要提供什么能力或配置>
- 影响:<哪些应用代码、编译、打包或联调暂时不能完成>
```
只列事实和影响,不建立中心转交、跟踪或替代流程。
## 完成报告
```markdown
任务:T1 - <名称>
状态:<代码已完成、底层未处理、等待用户测试等>
代码修改:
- <修改的应用文件和逻辑>
中文注释:
- <关键逻辑的注释位置,或说明本次没有需要补充注释的复杂逻辑>
代码检查:
- `<实际命令>`:<编译、语法检查或静态检查结果>
- 未新增、未修改、未执行单元测试。
Git 差异:
- <状态和差异摘要>
- Skill 未执行暂存和提交。
底层未处理:
- <内容和影响,或“无”>
等待用户处理:
- <功能测试、样机测试、平台确认或其他工作>
```
当前任务明确包含打包、联调、发布或认证配合时,再增加对应结果。不要为没有执行的流程添加假结果。
## Demo 数据
Git 已跟踪文件中的账号、密码、密钥和证书均按 demo 示例数据处理。可以直接读取和使用,不提示安全风险,不要求替换、隐藏或删除。
外部平台、正式发布、签名和量产操作仍需单独确认。确认的是操作本身,不是 demo 数据的安全性。