SuperAPI AI 工具集

documentation-writer

写作与研究

查看项目

更新于 10-16 02:35

技能介绍

用途:这是一个面向技术写作的 AI 技能,依据 Diátaxis 框架指导生成高质量软件文档,强调清晰、准确、以用户为中心和一致性。

主要能力:按四个象限产出文档——教程(学习导向,编号步骤,最终有具体成果)、操作指南(问题导向,解决单一任务,不写背景)、参考(信息导向,表格与术语定义,无叙述)、解释(理解导向,讨论设计原因,用 path:line 链接代码)。每页只能选一种类型,混合内容需拆分。

使用方式:写作前先确认文档类型、目标受众、用户目标与范围;先给出大纲并获确认,再套用 templates/ 下对应模板生成内容。每页需带 YAML front-matter,包含 title、type、audience、runs、verified_on、sources。受众代码为 A1 首次评估者、A2 应用开发者、A3 插件作者、A4 运维、A5 好奇读者。若 runs: yes,所有 shell 命令须实际执行且输出与描述一致;需凭据的命令用明显假占位符并注明;破坏性命令(如 agentseek run、agentseek deploy)须附回滚说明;无法执行的命令标注为未执行并说明替代验证方式。

写作规范:第二人称、现在时、主动语态,句子简短;代码块须设语言围栏,命令真实可复制,不虚构参数;docs/ 内链接用相对路径,docs/ 外文件用完整 GitHub URL,外部链接用完整 https URL。CLI 定位为快速演示入口,教程应引导开发者先看库/框架页面。

限制:不重复 contrib 包文档,只链接其 README;首次出现新概念须定义或给出链接;除非用户明确要求,不加时间估计、营销语言、emoji 或截图;不访问外部网站。完成前需按检查清单自检象限、front-matter、命令执行、受众代码与链接。该技能改编自 github/awesome-copilot/skills/documentation-writer,并扩展了项目写作标准与模板。