SuperAPI AI 工具集

docs-style

写作与研究

查看项目

更新于 10-15 21:39

技能介绍

docs-style 是技术文档写作与审阅的风格规范,目标是保证清晰、一致,并兼顾人类读者与 LLM 的理解。

用途:撰写新文档、审阅文档、编辑既有文档、编写代码示例时套用统一原则。

主要能力:

  • 先区分 Diataxis 四种文档类型:Tutorial(学习)、How-To(完成任务)、Reference(查阅)、Explanation(理解),不混用。可用“行动还是认知、获取还是应用”两组问题判断。
  • 语气与人称:直接称呼读者为 you;优先主动语态;删去冗余词(如 in order to 改 to、due to the fact that 改 because)。
  • 结构:标题具体明确;页面自包含(说明功能、前置条件、上下文);正确使用标题层级、列表、表格、代码块;段落保持 3-4 句以内,先给关键信息。
  • 一致性:同一概念使用同一术语并记录术语选择;统一 UI、代码、路径、占位符格式。
  • LLM 友好:显式列出前置条件;首次出现时展开缩写;提供完整可运行的代码示例(含导入、合理占位值与预期输出);为页面写标题与元描述。
  • 避免:以产品为中心的语言、显而易见的分步 UI 操作、口语化表达。

使用方式:不存在安装命令,按文档中的检查清单逐项核对即可;判断类型时可参考 references/diataxis-compass.md。

适用场景:技术文档、API 参考、教程、操作指南、概念解释、代码示例编写。

限制:资料未提供价格、平台支持范围、安装或集成方式等信息,暂未提供。