SuperAPI AI 工具集

documentation

写作与研究

查看项目

更新于 10-16 05:43

技能介绍

用途:面向代码文档写作,覆盖README、API文档、内联注释、技术指南与架构决策记录(ADR)五类内容,目标是让读者理解并正确使用代码。

主要能力与结构:给出各类文档的目的、读者、关键章节和模板。README模板含项目简介、功能、安装(npm install project-name)、快速开始、用法、API参考、配置、故障排查、贡献和许可。API文档模板区分REST接口(端点、认证、请求头、请求体参数、成功与错误响应、cURL与JavaScript示例、限流)和函数/方法文档(JSDoc/TSDoc,参数、返回值、异常与示例)。内联注释指南区分应写(为什么、权衡、临时方案、复杂逻辑、边界、性能与安全)与不应写(显而易见的“做什么”、冗余、被注释掉的代码),并列出TODO/FIXME/HACK/NOTE格式。技术指南模板含前置条件、概述、分步说明、可运行示例、常见问题。ADR模板含状态、日期、决策者、上下文、决策、备选方案、后果与参考。

使用方式:按读者受众选择文档类型并套用对应模板;示例应可复制运行,包含必要导入。

限制:资料未说明该技能是否可直接安装、是否有命令行工具、收费或价格、支持平台等信息,暂未提供。