SuperAPI AI 工具集

docs-writer

编程与开发

查看项目

更新于 10-15 19:56

技能介绍

用途:docs-writer 是一个技术文档写作技能,用于创建清晰、完整、面向开发者与终端用户的文档,包括 API 文档、README 文件和用户指南。

主要能力:按需加载不同阶段文件,API 文档对应 phases/01-api-docs.md,用户指南对应 phases/02-user-guides.md,README 对应 phases/03-readme.md。提供常见章节结构参考,如 README 的安装→快速开始→用法→API→贡献,API 文档的总览→认证→端点→Webhook→错误,用户指南的入门→功能→教程→排错。还提供 API 端点模板与 README 模板。

使用方式:采用增量生成工作流,先做分析(列出所需章节并询问先写哪个),再生成一个章节并写入或编辑文件,然后报告进度并询问是否继续,逐节重复。每次响应只写一个章节,API 分组每次 3 至 5 个端点,单次响应不超过 2000 tokens。

面向 LLM 的文档模式:要求每份文档包含机器可读的 frontmatter(title、tldr、business_value、complexity、last_verified、stakeholder_relevant、dependencies),并在标题后加入 TL;DR 摘要块(What、Why、How、Dependencies)。内容优先使用表格、项目符号、代码块和标题,便于扫描。功能文档应包含业务价值、成功指标与风险或限制。

编号文档目录:创建 docs/NN-* 目录前需检查已有编号前缀,每个数字前缀只能使用一次,99 保留给 99-archive,发现冲突需重新编号。

配图:需要图表或插图时可使用 /sw:image-generation 技能。

限制:资料未提供该技能的安装方式、收费、价格、平台支持或实际效果等信息。