用途:为任意代码项目生成一套给新同事看的循序渐进文档,输出到项目 docs/ 目录,含 01_architecture、02_philosophy、03_lang_concepts、04_code_walkthrough、05_runtime_model、06_build_guide、07_integration_guide、08_debug_guide、09_design_conventions 共九篇。适用于“生成项目文档”“新人文档”“架构文档”“代码导读”“深入理解项目”等场景;面向导师、评委、HR 的论文章节或项目梳理不适用,应改用 codegen-doc。
主要能力:先判断是全部生成、只写指定几篇,还是按代码变更更新受影响篇目;docs/ 已有内容时先列出文件并询问覆盖、跳过或备份到 docs.bak/,不直接覆盖。读项目分三步(看轮廓、看骨架、跟完整例子走一遍),结果记入 docs/.project-map.md,后续各篇的路径、类名、代码均从该文件取,术语表至少 5 条。默认模板偏向需编译、有多线程与进程间通信的项目,前端、数据脚本、库类项目须按对照表替换或跳过篇目,编号固定,跳过留空号不往前挪。
写作要求:贴代码前必须先读文件确认内容,引用带位置如 src/core/channel.cpp:120-135;每篇开头一句说明解决的问题,按“是什么→为什么→怎么做”组织,含对比、生活化例子和结尾速查表或检查清单;调用关系、时序、状态、继承用 Mermaid,目录树、分层、内存布局用 ASCII 且宽度不超过 80 字符;每篇 300–600 行;术语前后一致,不生造名词。最后写 docs/README.md 目录页并逐篇对照 quality.md 自查,向用户说明写了哪些篇目及行数、跳过原因、标为 ⚠️ 未验证的内容、.project-map.md 中尚未弄清的部分。
限制:资料未提供具体安装命令、收费方式或平台支持信息。