SuperAPI AI 工具集

documentation

写作与研究

查看项目

更新于 10-16 01:16

技能介绍

用途:把文档作为一等工程产物对待,降低新人上手时间、支持工单数量与认知负担。

主要能力:按类型组织文档——README(面向新开发者,快速开始)、API 文档(面向 API 使用者,参考手册)、架构文档(面向团队,设计决策)、Runbook(面向运维,故障响应)、教程(面向用户,学习材料),并给出各自的更新频率建议。

内容规范:README 结构含一句话描述、构建/覆盖率/许可证徽章、特性列表、快速开始(安装、环境变量配置、运行)、前提条件、使用示例、API 参考链接、贡献与许可证。API 文档采用 OpenAPI/Swagger 描述,包含认证、限流说明、分页参数、响应示例与错误响应。代码文档使用 JSDoc/TSDoc 标注参数、返回值、示例、异常与版本;内联注释强调解释“为什么”而非“是什么”。架构决策记录(ADR)提供模板,含状态、背景、决策、备选方案、后果与参考链接,并维护 ADR 索引表。Runbook 结构含概述、前提、症状、诊断步骤、缓解措施、解决标准与升级路径。

工具提及:Docusaurus、Swagger UI、Storybook、MkDocs、Notion。

限制:资料未提供该技能的具体安装方式、运行命令、收费信息与平台支持范围,暂未提供。