SuperAPI AI 工具集

technical-writing

写作与研究

查看项目

更新于 10-16 03:06

技能介绍

用途:用于仓库文档,包括 README、指南、参考、流程文档、规范和技术 PR 描述。适用于编写、组织、命名、编辑或评审企业开发者文档、规范与技术说明。

主要能力:先确定读者、预期动作或决策、页面范围与事实来源,阅读当前代码、模式、测试、命令输出和相关差异。可选择三种模式:基于证据创建、在保留有用事实与作者意图的前提下编辑、先给出发现再提出修复的评审。写作上要求使用现在时、主动语态、具体名词和一词一概念,首次使用缩写时展开,以读者可完成的任务和一条推荐路径开头。所有写作均需执行简洁化处理,去除填充、套话、空泛声明和重复解释。

使用方式:开始前先阅读适用的 AGENTS.md,它决定文档位置、长度限制和仓库术语。该技能无需全局工具或技能安装。组织与命名文档时阅读 Organization and naming,为每个契约、默认值和行为指定唯一归属页面。示例需展示真实安全输入和准确标识符类型,标注占位符,必要时引用 YAML 值并指定代码块语言。编辑时先纠正不准确或不安全的声明,再补缺失要求与失败处理,最后去重并收紧文字。

适用场景:仓库文档的创建、编辑与评审,开发文档的组织与命名,驱动契约的编写或重写,技术 PR 描述,规范与运行时流程文档。

限制:需以当前源和证据为依据,无法验证的内容必须标注不确定性和缺失的证据。评审任务中不应静默改写源文档。仅文档变更时使用格式化、构建、链接检查和视觉检查,不新增或运行测试。不得包含真实凭据。未提供具体命令、安装命令或平台支持信息。