用途:为 PRPM 仓库提供文档组织、结构与维护的统一标准,确保用户文档、开发文档与 AI 技能文档保持一致。
主要能力:按受众划分文档位置。内部开发文档放 development/docs/(如 GITHUB_WORKFLOWS.md、PUBLISHING.md、DEVELOPMENT.md、DOCKER.md),面向贡献者与 CI/CD;用户文档放项目根目录 docs/,含用户指南、API 文档、包编写指南、CLI 命令参考与示例教程;项目级文件放根目录,如 README.md、CONTRIBUTING.md、CHANGELOG.md、LICENSE、ROADMAP.md;AI 助手知识库放 .claude/skills/,含 postgres-migrations-skill.md、pulumi-troubleshooting-skill.md、NEW_SKILLS.md 及 prpm-development/、self-improving/、thoroughness/ 子目录;每个包在 packages/*/README.md 提供自身说明。
使用方式:Markdown 文件用 kebab-case 命名,超过 200 行加目录,标题层级为 # → ## → ###,代码示例带语法高亮。交叉引用使用相对路径,移动文件后更新所有引用。重组文档时按清单移动文件、更新引用与 README 链接、检查 .gitignore、测试链接并清晰提交。维护上每季度审查 docs/,删除过时内容,更新示例与链接;新增功能时更新用户文档、内部文档、示例与 CHANGELOG.md;弃用功能时加弃用通知与迁移指南。
工具与限制:文档生成器 TypeDoc、VitePress 或 Docusaurus 标注为未来计划;可用 markdownlint docs/ 检查 Markdown,用 markdown-link-check docs/**/*.md 检查链接;构建文档站点为未来功能(cd docs/ 后 npm run build)。资料未提供具体收费、平台与效果信息。版本标注最后更新 2025-10-21,适用于 PRPM v2+,审查日期 2026-01-21。