documentation-standards

documentation-standards 技能为 PRPM 生态系统内的存储库技术资讯管理提供了全面的架构。它为文档放置建立了清晰的分类法，将内容区分为开发专用指南、用户教学以及 AI 代理的专业知识库。遵循这些标准，贡献者和自动化系统可以可预测地定位资讯，减少上下文切换并提高 AI 辅助编码作业的可靠性。此技能作为存储库维护、文档版本控制和生命周期管理的结构化参考。

• 将文档分类为内部 (development/docs/)、用户导向 (docs/)、项目层级 (root) 以及 AI 专用 (.claude/skills/) 目录，实现直觉式导航。

• 定义明确的 Markdown 结构要求，包括前言使用、标题层级 (H1-H3)、长篇文章目录及标准化的代码区块格式。

• 提供迁移检查清单，确保在文档重组期间的链接完整性和存储库健康度，并包含使用 markdown-link-check 进行自动链接检查。

• 强制执行套件专属的 README 结构，以促进个别套件目录内的 API 参考、使用教学与 CLI 指令文档。

• 整合 TypeDoc、VitePress 和 Docusaurus 等自动化文档工具，支持未来的静态网站生成与多格式输出。

• 使用相对路径强制执行交叉引用规范，确保内部开发资源与外部用户指南之间的导航链接保持稳固。

• 专为 PRPM 贡献者、维护者、套件作者以及在存储库中运作的 AI 代理设计。

• 提供新增、弃用与审查文档的最佳实践，确保资讯随着项目演进保持准确与关联性。

• 通过 markdownlint 支持自动化 lint 工作流程，以维护风格一致性并防止格式回归。

• 非常适合管理多套件存储库的复杂性，解决技术债通常表现为无组织或过时的文档之问题。

• 鼓励进行季度审查并系统性更新 CHANGELOG.md，确保所有功能新增与项目里程碑皆能妥善记录。