用途:为项目提供技术文档写作规范与模板,涵盖架构决策记录(ADR)、API 文档、运维手册(Runbook)和 README,并给出统一的 docs/ 目录结构。
主要能力:提供 ADR 模板(含状态、日期、作者、Context、Decision、Consequences、Alternatives、References 等章节)及示例;提供 OpenAPI 3.0.3 与 Markdown 两种 API 文档写法,含认证、限流、参数表与响应示例;提供 Runbook 模板(前置条件、步骤、验证、回滚、故障排查、联系人);提供 README 模板(徽章、快速开始、架构图、开发命令、贡献流程、许可证);支持 Mermaid 流程图、时序图与 ER 图;附 Markdown 风格指南与文档检查清单。
使用方式:按 docs/ 目录组织文档,套用对应模板填写;ADR 用主动语态描述决策;API 文档可用 OpenAPI 或 Markdown 表格;命令示例保持原样,如 git clone、make dev、make test、make lint、make build。
适用场景:需要记录架构决策、对外发布 API、编写运维与应急流程、维护项目 README 的工程团队。
限制:资料未提供安装命令、收费方式、平台支持或自动化生成能力,相关事实暂未提供。