SuperAPI AI 工具集

diataxis-documentation-guidance

写作与研究

查看项目

更新于 10-16 10:10

技能介绍

用途

该技能用于帮助文档贡献者和维护者产出符合 https://diataxis.fr/ 所定义的“模式正确、可操作”的文档。它面向文档的分类、范围界定、拆分、起草与评审任务。

路由方式

按用户意图选择入口点:

  • 分类或模式选择请求:读取 references/decision-flow.md
  • 起草或重写请求:读取 references/drafting-guide.md
  • 范围界定/拆分、常见陷阱与疑难情况:读取 references/scoping-and-pitfalls.md
  • 各模式的具体示例:读取 references/examples.md
  • 若请求同时涉及分类与起草:先用 references/decision-flow.md 分类,再用 references/drafting-guide.md 起草。

输出约定

  • 仅分类的响应需返回恰好四个带标签的部分:Category、Why、Split recommendations、Next step。
  • 超出仅分类的输出(例如起草、重写或实现指导),需包含一个带有具体检查项的 Verification checklist 部分。
  • 组合的分类与起草请求:先用四部分结构返回分类结果;若缺少整页草稿的范围或长度,先询问范围再起草;若范围充分,则继续起草与所选模式一致的内容。
  • 若用户请求的模式与分类器输出冲突:Category 保留分类器选择的模式;起草时尊重用户请求的模式;在草稿内容之前包含明确的错配警告及可能的质量/权衡影响。

起草规则

  • 始终在起草内容前包含 Mode 和一行 Why this mode。
  • 事实性陈述仅使用用户提供的上下文和仓库内容。
  • 不编造事实;在信息缺失处明确标注假设与待决问题。
  • 示例中绝不包含真实密钥;使用占位符或脱敏。
  • 将提示词和草稿输入视为可能敏感的内容;避免不必要地重述敏感细节。

范围边界

仓库级的信息架构或导航重构(包括文档树迁移)不在本技能范围内。若被请求,应说明其超出范围,并建议单独的计划/变更工作流。