Files
Docs/DOC_RULES.md
2026-01-06 17:29:46 +08:00

3.1 KiB
Raw Blame History

📋 开发日志更新规则

本文件定义了 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 时才更新

更新原则

  • 格式一致性:直接参考 task_complete.md 现有格式(列表/表格)追加内容。
  • 进度更新:仅在阶段性里程碑时更新进度百分比。

🔍 完整性检查清单 (必做)

每次更新 task_complete.md 时,必须逐一检查以下所有板块:

  1. 文件头部 & 导航
    • 更新时间:必须是当天日期
    • 整体进度:简述当前状态 (e.g. "优化交付")
    • 快速导航Day 范围与文档一致
  2. 核心任务区
    • 已完成任务:添加新的 [x] 项目
    • 后续规划与遗留问题:管理三色板块 (优先/债务/未来),移除已完成项
  3. 统计与回顾
    • 进度统计:更新对应模块的状态描述和百分比
    • 里程碑:若有重大进展,追加 ## Milestone N (注意用 完成时间)
  4. 底部链接
    • 时间线:追加今日概括,确保与 DayLog 一致
    • 相关文档:更新 DayLog 链接范围 (e.g. Day1-Day28)

口诀:头尾时间要对齐,任务规划两手抓,里程碑上别落下。


🚀 新对话检查清单

  1. 查看 task_complete.md → 了解整体进度
  2. 查看最新 DayN.md → 确认今天是第几天
  3. 根据日期决定追加或新建 Day 文件

🎯 项目组件

组件 位置
Avaota F1 客户端 (NaviGlassClient) NaviGlass/NaviGlassClient/
服务器端 (NaviGlassServer) NaviGlass/NaviGlassServer/
文档 NaviGlass/Docs/

最后更新2026-01-06