SuperAPI AI 工具集

documentation-standards

写作与研究

查看项目

更新于 10-15 23:42

技能介绍

用途:为软件项目提供通用文档规范与最佳实践,帮助在不同项目与领域间统一文档结构、格式和模板。

主要能力:给出通用文档目录结构(如 docs/ 下的 README、architecture、development、api、user 等);推荐文档格式(Markdown、Google Docstrings、JSDoc、Swagger/OpenAPI);提供 Markdown 规范(ATX 标题、限制 3-4 级标题、代码块标注语言、列表与链接写法);提供 API 文档模板(端点、方法、参数、响应、示例);提供 Python docstring 模板;提供教程模板(前置条件、分步操作、故障排查);列出最佳实践(一致性、可维护性、可访问性、完整性)。

使用方式:资料未提供具体安装或调用命令,仅说明在为新项目搭建文档、跨团队统一文档、创建可复用文档模式、实施可维护文档流程时使用该技能。

适用场景:所有软件项目、任意文档系统、跨项目标准化、组织知识管理。

限制:资料未提供收费、价格、平台支持、效果数据或具体安装步骤,相关事实暂未提供。