用途:docs-pro 用于管理技术文档的完整生命周期,衔接代码实现与面向用户的清晰说明,核心思路是把文档当作代码(DaC),借助 AI 让新功能、配置和 API 变更在提交后数分钟内反映到文档中。
主要能力:自动化同步审计,扫描代码库中未被记录的导出、设置和开关;风格执行,确保文档遵循 2026 Squaads AI 风格指南;模块化内容架构,管理可复用片段与模块化页面;多模态文档,整合 Mermaid 图表、代码示例与交互元素。
使用方式:快速同步审计可依次运行 git diff main...HEAD -- src/、rg "export (const|function|class)" src/ --type ts、ls -R docs/。功能发布文档按概览、配置、示例、故障排查组织;API 参考更新应先改源码中的 JSDoc/TSDoc 注释,再运行文档生成器(如 make build-docs),并核对输出是否符合 Markdown 标准。AI 工作流为:盘点代码库功能、与现有 .md 做差距分析、起草内容、人工复核语气与准确性。
质量与限制:要求主动语态、现在时、直接称呼,代码示例须经测试有效,每个页面须在 mkdocs.yml 中以描述性标题列出。反模式包括“点击这里”链接、过时默认值、手工维护参考文档、大段文字和混用语言,应改用描述性锚文本、同步审计、从代码文档字符串生成 API 参考、要点/表格/图表,并保持 docs/ 以英文为唯一事实来源。具体收费、价格、平台支持与效果数据暂未提供。