SuperAPI AI 工具集

write-openspec-docs

写作与研究

查看项目

更新于 10-15 21:42

技能介绍

用途:切换到 OpenSpec 文档写作模式,加载内部风格指南,按该语体起草或修订页面。风格要点为行动优先、无前言、可扫描,把页面视为检索面而非文章,每节开头先给答案。

主要能力:区分页面类型。指南按读者任务组织;参考文档镜像产品结构,使用确切的字段、命令与文件名作为扫描锚点,并需完整覆盖,不把多个事实压缩进一句或一格。先写能回答问题的最短版本,精简页面易扩展,臃肿页面只能重写。用词平实、尽量少;多数读者会跳过的深度内容放到链接之后;命令、真实输出、失败与修复等载荷保持完整。

使用方式:起草前先加载 no-ai-slop 技能(负责通用空话模式),writing.md 负责 OpenSpec 文档的具体样貌。编辑前通读目标页面。参考页须先从源码梳理契约。示例可参考 docs-lab/start/setup.md 的节区形状与清单写法、docs-lab/start/installation.md 中 Uninstalling 的多步任务写法。

结构与限制:不用固定模板。清单先以列表列出全部条目,再各自展开。有序步骤用编号,清单用项目符号,单一想法与推理用短段落。每个承重事实须落在扫描锚点上:代码块、加粗编号引导、Term: 事实项、表格或文件树,不能只藏在段中。

完成前后:做两项兜底检查——可检索性(每个问题或确切产品名能否仅靠扫描找到)与观感(渲染后是否显得可完成);表格密集的改动需在桌面与窄宽度下检查,不合格当场修复。事实只存在于一页,其他位置链接过去。只写真实事实;无法低成本核实的说法标注为未核实,不得用貌似合理的句子填补。文档树 README 拥有页面地图与结构不变量,重构或新增页面前先查阅。完成后向用户说明改动并列出未核实项。若用户要求深入、证据优先的写作会话,遵循 full-process.md。