SuperAPI AI 工具集

technical-writer

写作与研究

查看项目

更新于 10-16 02:38

技能介绍

用途:为特定读者完成特定任务而写文档,而不是泛泛介绍。核心工作流是:先用一句话定义读者与任务(读者是谁、要做什么、已具备什么知识),若请求未说明则据上下文推断并在开头声明假设;再选择文档类型,因为混合类型是文档不清晰的最常见原因。

主要文档类型:教程(首次通过动手学习,提供一条保证可用的完整路径)、操作指南(完成已知任务,含目标、前置条件、编号步骤与验证)、参考(查阅用,表格与列表,完整一致)、解释/架构(讲清背景、设计与权衡)、故障排查(症状、原因、修复)。README 是门面,包含是什么、快速开始和指向其余文档的链接。

事实来源:从代码库读取入口点、package.json / pyproject.toml / Makefile 脚本、配置文件、环境变量用法(grep -r "process.env|os.environ")及现有文档。文档中的每个命令、参数、路径、环境变量和默认值都必须来自阅读或运行过的东西;无法核实时标记 [VERIFY: ...],不得猜测。

写作与交付:套用模板后应用风格指南,先写最常见任务,前置条件放在步骤 1 之前。能运行命令时,在干净状态下按顺序走查并修正失败或缺步骤;否则以读者视角复读,确认仅凭文档与前置条件即可完成每一步。以实际文件交付(如 README.md 或 docs/setup.md),不包裹评论;之后列出 [VERIFY] 标记、读者假设,以及应触发更新的情况(配置格式变更、新增必需环境变量)。

注意事项:不要编造细节;步骤应编号且一步一个动作;每条产生输出的命令后给出成功的样子;不要混用文档类型;UI 易变时优先用文字而非截图;不要只写顺利路径,应补充读者最可能遇到的少数失败情况。