Files
chromebox_10th_audio_driver/docs/meta/DOCUMENTATION_ARCHITECTURE.md
2026-04-05 13:24:31 +08:00

2.3 KiB
Raw Blame History

文档架构与进度备忘

分工DOCUMENTATION_STYLE.md怎么写;本文管入口与进度文件往哪放。不替代 INDEX.md 全表。


1. 人读入口

根目录 唯一 README.mdINDEX.md(主题)/ REPO_INDEX.md(路径)/ WORK_PROGRESS.md(阶段与 clone

flowchart LR
  R["README"]
  R --> A["INDEX"]
  R --> B["REPO_INDEX"]
  R --> C["WORK_PROGRESS"]
  A --> H["linux-hdmi/"]
  B --> S["scripts/\npatches/"]
入口 用途
README 概况、任务、速链
INDEX 按主题找文
REPO_INDEX 路径与文件名
WORK_PROGRESS 阶段、结论、clone

2. AI / BMad

文件 作用
index.md AI 主索引(勿与 INDEX 合并)
_bmad-output/project-context.md GPC 规则
_bmad-output/* 草稿 结论应收敛到 docs/ 或 WORK_PROGRESS

3. docs/ 分区(概览)

linux-hdmi路线图 / FIX_PLAN· kernel-build · meta · windows根级占位链到 meta/ 与 BMad。跨平台纲REPAIR_Plan_Audio.md


4. 进度类文件

文件 内容
WORK_PROGRESS 事实、阶段、版本、clone
next.md 临时下一步;有重启须写重启后
Roadmap 目标、排除项、成功标准
FIX_PLAN 源码对比分支 AD

路线图与 WORK_PROGRESS 交叉更新FR17:阶段跳转或重要结论变更时,更新 路线图 § 五、维护与「当前阶段」WORK_PROGRESS 顶部「Linux HDMI」段落之一核对另一处链接与事实,避免与 FR2 分工冲突。


5. 改文自检1 分钟)

  1. 新文已在 INDEX(必要时 REPO_INDEX)加一行。
  2. Linux HDMI 阶段结论已写 WORK_PROGRESS 首段。
  3. 短期步骤(含重启)已更新 next.md

6. 边界

勿仅为「好看」批量改 linux-hdmi/ 文件名。真要搬迁:grep 旧路径 → 改 INDEX / REPO_INDEX / WORK_PROGRESS → 再移动