2.2 KiB
2.2 KiB
📋 开发日志更新规则
本文件定义了 AI 助手更新开发文档的规范
⚡ 核心原则
| 规则 | 说明 |
|---|---|
| 默认更新 | 只更新 DayN.md |
| 按需更新 | task_complete.md 仅在用户明确要求时更新 |
| 增量追加 | 禁止覆盖/新建。请使用 replace/edit 工具插入新内容。 |
| 先读后写 | 更新前先查看文件当前内容 |
📁 文件结构
NaviGlass/Docs/
├── task_complete.md # 任务总览(仅按需更新)
├── implementation_plan_complete.md # 实现计划详情
└── DevLogs/
├── Day1.md # 开发日志
└── ...
📅 DayN.md 更新规则(日常更新)
新建判断
- 检查最新
DayN.md的日期 - 今天 → 追加到现有文件
- 之前 → 创建
Day{N+1}.md
追加格式
---
## 🔧 [章节标题]
### 问题描述
简要描述...
### 解决方案
```code
# 代码示例
结果
- ✅ 修复了 xxx
### 快速修复格式
```markdown
## 🐛 [Bug 简述] (HH:MM)
**问题**:一句话描述
**修复**:修改了 `文件名` 中的 xxx
**状态**:✅ 已修复 / 🔄 待验证
📝 task_complete.md 更新规则(仅按需)
⚠️ 仅当用户明确要求更新
task_complete.md时才更新
更新内容
## ✅ 已完成任务
### [模块名称]
- [x] 功能描述 (Day N)
- [x] 子功能 1
进度表更新
| 模块 | 完成度 | 状态 |
|------|--------|------|
| 网络通信 | 100% | ✅ 完成 |
- 仅在阶段性里程碑时更新进度百分比
🚀 新对话检查清单
- 查看
task_complete.md→ 了解整体进度 - 查看最新
DayN.md→ 确认今天是第几天 - 根据日期决定追加或新建 Day 文件
🎯 项目组件
| 组件 | 位置 |
|---|---|
| Avaota F1 客户端 (NaviGlassClient) | NaviGlass/NaviGlassClient/ |
| 服务器端 (NaviGlassServer) | NaviGlass/NaviGlassServer/ |
| 文档 | NaviGlass/Docs/ |
最后更新:2025-12-25