SuperAPI AI 工具集

documentation-standards

写作与研究

查看项目

更新于 10-15 22:11

技能介绍

用途:确保技术文档遵循 C4 架构模型与 Hack23 标准,保持结构、格式与图表风格一致。

主要能力:提供文档结构模板(标题与用途、文档版本、最后更新日期、分类、所有者、执行摘要、正文、相关文档、文档控制信息如仓库、路径、格式、下次评审日期);支持 C4 三个层级的 Mermaid 图表示例:Level 1 系统上下文、Level 2 容器、Level 3 组件;给出 Mermaid 图表最佳实践,如清晰描述性标签、子图统一样式、合适图表类型、颜色编码、必要时添加图例。

使用方式:按模板组织 Markdown 文档,使用 Mermaid 绘制架构图,遵循 AI FIRST 质量原则——不接受初稿质量,至少迭代 2 次,通读全部输出并改进每个章节。

适用场景:需要统一技术文档、架构说明与图表规范的团队或项目。

限制:资料未提供具体安装命令、平台支持、收费方式或自动化校验工具;文档控制字段中的仓库 URL、路径、评审日期等需按实际项目填写。