← ClaudeAtlas

write-project-docslisted

检查代码库并创建、维护、归并、标准化或迁移固定的简体中文项目文档集合。产品、架构、开发规范、源代码规模四类权威文档各支持一个中文或英文规范文件名。用于新项目补文档、仓库文档审查、规范文件名对齐、��构与项目专属开发规则归并、源代码规模治理,或修复现有根 AGENTS.md 的托管文档导航区块。保留有价值的专项文档;只在用户明确要求时处理 ADR。
coachpo/plugins-claude · ★ 0 · AI & Automation · score 71
Install: claude install-skill coachpo/plugins-claude
# write-project-docs 创建和维护简洁、以仓库事实为依据的简体中文文档集合。八个规范文档、各自的权威边界和允许的中英文路径,是所有使用本技能的项目共享的约定;不要为单个项目增加特例或按项目名分支。 选定的开发规范路径是工程规则入口,也是已核实的项目与技术实现规则的唯一权威;选定的源代码规模规则路径是物理独立、与项目无关的专项策略。项目根目录的 `AGENTS.md` 是指令与导航界面,不是第九个规范文档;同目录的 `CLAUDE.md` 只是让 Claude Code 读到 `AGENTS.md` 的一行引用。 ## 规范文档集合 | 路径 | 权威范围 | | --- | --- | | `README.md` | 项目入口、简要说明、已验证命令、状态摘要和链接。 | | `STATUS.md` | 当前生命周期、部署、用户与数据、兼容性和允许变更的事实。 | | `CONTRIBUTING.md` | 项目特有的环境与命令,以及渲染后的共享贡献区块。 | | `docs/README.md` | 仅作为文档索引和权威映射。 | | `docs/产品说明.md` 或 `docs/product.md` | 产品问题、用户、目标、范围、流程、需求和验收事实。 | | `docs/架构说明.md` 或 `docs/architecture.md` | 唯一架构权威:当前设计、模块与数据责任组件、边界、依赖方向、风险及具体架构或安全例外。 | | `docs/开发规范.md` 或 `docs/development-rules.md` | 工程规则入口,以及已核实的项目与技术实现规则的权威来源;必须链接源代码规模专项策略。 | | `docs/源代码规模与职责规则.md` 或 `docs/source-code-size-and-responsibility-rules.md` | 由捆绑资源模板渲染、物理独立、与项目及技术无关,并从属于开发规范入口的规模与职责策略。 | 四类双语权威各自独立选路径:只存在一个变体时沿用该路径;两个都不存在时默认创建中文路径,除非用户明确要求英文路径。同一权威只能保留一个变体,不用重定向、符号链接或重复正文同时暴露两个名称。文件名用英文时,说明性正文仍用简体中文。 保留项目确有需要、独立有价值的专项文档,例如 API 参考、数据字典、UI/UX 指南、设计系统、测试策略、安全设计、研究、发布和运维文档。不为模板对称创建空文档。 ## 边界 - **只改项目文档。** 根 `AGENTS.md` 的例外是:它已存在、是普通非符号链接文件、不是生成或外部维护的文件,且适用指令允许时,通过 `scripts/update_agents_navigation.py` 更新托管导航区块和其中规定的路径引用。不创建根 `AGENTS.md`(那是 `init-deep` 的职责),不手工改写它的其他内容。子目录 `AGENTS.md`、`.claude/rules/` 和其他指令文件只检查并报告。 - **`CLAUDE.md` 只作引用,不承载内容。** 根 `AGENTS.md` 存在而同目录没有 `CLAUDE.md` 时,创建一个完整内容只有 `@AGENTS.md` 一行的 `CLAUDE.md`,让 Claude Code 读到同一份指引。已存在的 `CLAUDE.md` 一律不追加内容;它含有实质内容时只报告,交给 `init-deep` 处理。 - **事实只来自用户指令或仓库证