SuperAPI AI 工具集

documentation

写作与研究

查看项目

更新于 10-15 23:56

技能介绍

用途:该技能在编写文档或审阅文档时使用,提供文档编写指南与标准,帮助统一项目文档的格式和内容组织。

主要能力:涵盖若干常见文档类型的规范要点。README 需包含安装、快速开始、配置和命令等内容;CHANGELOG 采用 Keep a Changelog 格式;ADR(架构决策记录)用于记录重大技术选择;代码注释应解释“为什么”而非“是什么”;API 文档建议使用 OpenAPI/Swagger 规范。

使用方式:资料中仅说明可在写作或审阅文档时调用该技能,并提示可查阅 REFERENCE.md 获取详细文档。未提供具体安装命令、调用参数或集成步骤,暂未提供。

适用场景:适用于项目 README、变更日志、架构决策记录、代码注释以及 API 规范文档的撰写与评审。

限制:资料仅给出快速参考条目,未说明支持的语言、平台、收费、价格或效果,暂未提供。