用途
Project Documentation 是一个文档生命周期技能,适用于 PHP/Laravel 以及 Node/TypeScript/React 项目。它帮助团队从零搭建文档基线、清理积累的杂乱 markdown 文件,并在日常开发中查询命名与放置约定。技能包含 25 条规则,分为 6 个类别,版本 1.0.0,采用 MIT 许可证。
主要能力
技能提供三种模式:
-
Bootstrap(引导):用于新项目或缺少文档的项目。步骤包括检测项目类型(通过 composer.json、package.json、artisan 等信号)、盘点现有 .md 文件、对照必备文件清单找出缺口、提出 docs/ 文件夹结构(architecture/、adr/、guides/、runbooks/、archive/)、在用户批准后生成模板(README、CHANGELOG、LICENSE、CONTRIBUTING、SECURITY、ADR-0001),并建议 CI 门禁(markdown-lint、链接检查、CHANGELOG 强制)。
-
Audit(审计):用于清理现有项目。对每个 .md 文件给出分类判定:KEEP(保留)、UPDATE(更新)、ARCHIVE(归档)、DELETE(删除)、MOVE(移动),并输出审计台账表格,包含文件、最后修改时间、判定、原因和操作。技能明确要求绝不自动删除,必须先提交用户批准。
-
Reference(参考):用于查询约定,例如如何命名文件、文件应放在哪里,或在代码审查中引用相关规则。
规则类别
规则按优先级分为六类:
- Structure(结构,CRITICAL):根文件归属、docs/ 文件夹、子文件夹布局。
- Naming(命名,CRITICAL):根文件用 UPPERCASE.md,docs/ 下用 kebab-case.md,ADR 文件用编号前缀,禁止日期、MyNotes.md、tmp/draft/final 等标记。
- Essential Files(必备文件,HIGH):README、CHANGELOG、LICENSE、CONTRIBUTING、SECURITY。
- Quality(质量,HIGH):简洁性、AI 生成内容识别、标题规范、代码块语言标签、链接描述性。
- Cleanup(清理,HIGH):AI 垃圾文件、重复内容、孤立文件、空占位文件。
- Lifecycle(生命周期,MEDIUM):新鲜度日期、归档、ADR 流程、CHANGELOG 纪律。
使用方式
技能通过读取 rules/ 目录下的规则文件工作,每个规则文件包含 YAML frontmatter、原因说明、错误示例、正确示例以及检测/执行指导。用户可要求“set up docs”“audit docs”“clean up markdown”等触发对应模式。技能还提供标准文件夹布局示例和文件命名速查表。
适用场景
- 启动新的 Laravel 或 Node/React 项目,需要文档基线。
- 接手 markdown 文件杂乱或充满 AI 生成内容的项目。
- 设置 docs/ 文件夹结构。
- 命名新文档文件。
- 决定是否删除 PLAN.md、TODO.md、IMPLEMENTATION-SUMMARY.md 等文件。
- 添加 markdown 质量 CI 检查。
- 审查添加或修改文档的 PR。
- 季度文档卫生清扫。
限制
技能不自动删除文件,所有删除或归档操作必须经用户批准。技能主要面向 PHP/Laravel 与 Node/TypeScript/React 项目,但规则本身大多与技术栈无关。关于收费、价格、平台支持等具体信息,资料中暂未提供。