SuperAPI AI 工具集

write-docs

编程与开发

查看项目

更新于 10-15 16:42

技能介绍

用途:这是 Agenta 仓库内用于编写或编辑 docs/ 文档页面的规范(概念页、操作指南、API 参考文字、教程),给文档写作提供风格、语气、结构与流程规则。

主要能力与规则:

  1. 以读者情境为先:面向不了解代码库的陌生读者,按情境、相关性、指令、参考四步组织非平凡内容;不假设读者想法,不写价值判断与未请求的建议。
  2. 每句只服务于该页读者的当前问题,删除无关内容;并列选项使用对称结构并优先展示推荐选项。
  3. 指令必须给出具体可复制示例,用精确词汇而非夸张形容词;指向其他页面用一句话加链接,不用整节展开。
  4. 按 Diátaxis 先定类型:教程(教学)、操作指南(完成任务)、参考(查事实)、解释(理解原理),不混用,需交叉时链接出去。
  5. 风格:主动语态、短句、11 年级英语表达;避免 comprehensive、powerful、seamlessly、easily、simply、robust、leverage 等营销词;不使用破折号(em dash)。
  6. 面向客户的术语:用 UI/API 中出现的词,如 application/workflow/evaluator、testset revision,首次出现链接概念页。
  7. 示例需脱敏但准确:使用占位 UUID,数据虚构但合理,形状须与线上 API 一致。
  8. 参考页保持干性:参数附描述、类型与是否必填;FastAPI 用 docstring 与 Field(description=...)。
  9. 概念页以心智模型开头,给一个实例,结尾指向相关操作指南与参考页。
  10. 不要提交 docs/docs/reference/api/ 下自动生成的 *.api.mdx;领域 PR 只改源头(docstring、Field 描述、api-guide 概念页),如需回退可执行 git checkout origin/<base-branch> -- docs/docs/reference/api/。

使用方式:写作前先读本规范,再按文档类型起草;发布前在 docs/ 运行 npm run build;API 文档改动在 api/ 运行 ruff format 与 ruff check --fix;PR 标题用 docs(docs): 或 docs(api):。

适用场景:Agenta 仓库内文档的撰写、编辑与评审,包括用子代理委派写作时的简报模板。

限制:仅针对该仓库文档流程,未提供安装命令、收费或平台支持信息。