SuperAPI AI 工具集

absolute-documentations

写作与研究

查看项目

更新于 10-26 16:16

技能介绍

用途

Absolute Documentations 把“写点文档”变成读者真正能用的文档。每篇产出物只服务一种读者需求,依据 Diátaxis 框架判定所属象限,用项目自身的语气和文档技术栈撰写,并在交付前对照实际代码库核验。它既能写新文档,也能把已有文档重写到所属象限的标准,还能对整个文档站做结构性审计。

核心框架:Diátaxis 四象限

每篇文档只回答一类读者需求,动笔前先分类,混用象限的页面谁都服务不好。

  • 实践/行动类:教程(tutorial)——面向新手的课程,保证一次成功;操作指南(how-to guide)——面向有经验用户的操作配方,帮助完成特定目标。
  • 理论/认知类:解释(explanation)——讨论式内容,说明背景、原因与取舍;参考(reference)——字典式内容,完整、中立地陈述机制事实。

分类时问两个问题:读者是在学习(获取技能)还是在工作(运用技能)?需要行动(可跟随的步骤)还是认知(可吸收的知识)?最忌讳混用:教程中途大讲架构会丢掉学习者,参考页给建议就不再是可信的纯描述。想混用时应链接到另一象限,而不是合并。

三种模式

  • WRITE(写作):用户说“写个教程/指南/README/文档”“记录这个功能”。
  • IMPROVE(改进):用户说“改进/重写/清理这篇文档”“这个 README 很差”。
  • AUDIT(审计):用户说“审计我们的文档”“文档一团糟”“重构文档结构”。

WRITE 模式流程

  1. 侦察:先读技术栈、现有文档(语气、术语、标题风格、frontmatter、导航结构)、被记录的代码(公开 API、真实选项名、真实默认值、真实报错信息,代码是事实来源)、项目元数据(包名、版本、安装命令、支持的运行时)。
  2. 需求确认:确定文档类型(哪个象限或哪种开发者文档形式)、目标读者(新手终端用户、有经验的操作者还是贡献者)、读者目标、范围(明确纳入什么,同样重要的是明确排除什么)。能从仓库得知的不要问用户。
  3. 大纲关卡(硬性关卡):写正文前先提出文件路径、带一句话说明的标题级大纲、每页服务的象限、需要的侧边栏/导航改动,然后停下等待明确批准。
  4. 撰写:按对应象限的 playbook 写,沿用项目既有语气,使用技术栈的组件与 frontmatter(未检测到技术栈时用纯 Markdown),对每个事实陈述和代码块执行准确性协议。
  5. 自查:按评分表打分,低于 4 分的先修,再附一段摘要交付。

IMPROVE 模式

根据位置、标题和内容判定页面本应服务的象限;若一页身兼两职,点明这通常就是根因。对照该象限标准列出具体违规项(缺章节、目的混杂、陈述过时、代码片段失效、读者层级错位)。保留前先核验:每个代码片段、选项名、版本陈述都对照当前代码检查。重写时保留所有准确且项目特有的内容,不要把项目语气漂白成通用文档腔。单页改进无需关卡;若需拆分或移动页面,属于重构,先提出移动方案并获批。

AUDIT 模式

  1. 盘点:列出每个文档页(站点页、README、docs/ 目录)的路径与标题。
  2. 分类:为每页指定主导象限,标记混用(最常见发现)、归错位置、重复、未接入导航的页面。
  3. 缺口图谱:按项目主要用户旅程构建四象限网格,标出缺失项。典型项目只有参考文档,第一篇教程往往是价值最高的缺口。
  4. 报告:一张发现表,含页面→现状→象限→动作(保留/重写/拆分/合并/移动/删除),按读者影响排序。
  5. 关卡:重构会移动文件、破坏链接,先提交方案获批,执行时包含重定向与链接更新。审计交付物是报告与方案,执行需用户明确批准后的后续步骤。

技术栈识别

按顺序检查标记文件,首个匹配生效:

  • source.config.ts 或 package.json 中的 fumadocs-* → Fumadocs(MDX + fumadocs-ui 组件)
  • docusaurus.config.* → Docusaurus(MDX + :::note 提示块)
  • astro.config.* 且含 @astrojs/starlight → Starlight(MDX/Markdoc + Starlight 组件)
  • mkdocs.yml → MkDocs(常配 Material,Markdown + !!! note)
  • .vitepress/config.* → VitePress(Markdown + ::: tip 容器)
  • mint.json / docs.json(Mintlify)→ Mintlify(MDX + Mintlify 组件)
  • 以上皆无 → 纯 Markdown(GitHub 风格,无组件)

各技术栈的 frontmatter、组件词汇、导航注册与象限到组件的映射见 references/docs-stacks.md。切勿混用语法(MkDocs 里不用 :::note,MDX 栈外不用 <Callout>)。

各象限要点

  • 教程:必须每次一次跑通;单一具体路径;每步可见结果;用第一人称复数“我们”。不得提供选项、夹带理论、假设未声明的环境、分支。
  • 操作指南:从真实任务出发;假设读者胜任;写明前置条件;只展示步骤。不教基础、不长篇解释原因、不在正文罗列所有边界情况。
  • 参考:完整、准确、中立;镜像代码结构;写明默认值、类型、约束。不给建议、不讲故事、不省略“显而易见”的条目、不与代码漂移。
  • 解释:给背景、原因、取舍、历史;承认替代方案;串联概念。不含操作步骤、不假装唯一正确、不重复参考事实。

常见开发者文档的象限组合:README 是落地页(卖点 + 快速上手迷你教程 + 外链);CONTRIBUTING 是面向贡献者的操作指南;ARCHITECTURE 是含参考元素的解释;ADR 是决策形态的解释、一旦接受不可更改;CHANGELOG 是参考、倒序、Keep a Changelog 格式;Runbook 是压力场景下的操作指南,简洁、祈使、可复制粘贴;API 参考是参考文档,尽量自动生成、外围手写文字。

准确性协议

代码片段来自代码库而非记忆;若片段可在当前环境运行则实际运行。名称必须精确,flag、选项、环境变量、端点、文件路径照抄源码,绝不改写(--dry-run 与 --dryrun 是不同产品)。默认值和版本是读出来的,不是回忆的。绝不记录不存在的东西:用户要求记录代码里找不到的功能时,停下并说明,不写“愿景式文档”。链接必须可解析,内部链接指向真实存在的文件或路由,锚点匹配真实标题。输出必须真实:文档说“你会看到 X”,X 就必须是命令实际打印的内容。

风格要点

一句一个意思,一段一个目的,一页一个象限。称呼读者用“你”(教程可用“我们”表示共同旅程)。指令用祈使语气:“运行构建”,而不是“你可以运行构建”。禁用居高临下的词:simply、just、easy、obviously、of course。用现在时和主动语态。每个代码块声明语言,文件内容块写明文件名。标题是可扫读的主张而非标签:“配置 webhook”胜于“配置”。术语定义一次后保持一致,不要为同一事物在“配置文件”“设置文件”“清单”之间优雅变体。警告放在危险步骤之前,绝不之后。删掉服务写作者而非读者的句子(道歉、清嗓子、营销话术)。

自查评分表

按象限纯度、读者匹配、准确性、完整性、可跟随性、语气、技术栈契合度各打 1–5 分,低于 4 分先修。

危险信号(停下修正)

教程给读者选项(“你可以用 npm 或 pnpm……”)——选一个,替代方案放操作指南;操作指南以三段背景开头——移到解释页并链接;参考材料带个性(“这个方便的选项……”)——中立化;解释页出现编号步骤——抽到操作指南;README 超过约 300 行——内容囤积,拆分并链接;一页超过 3 个提示块——已不再醒目;代码块无语言标签或片段未核验;“如上所述”“见下文”——重构结构以免需要叙述顺序;绕着 bug 写文档而不报告——告诉用户,由其决定。

参考文件(按需加载)

tutorials.md(写或修教程)、how-to-guides.md(写或修操作指南)、reference.md(写或修参考/API 文档)、explanation.md(写或修概念/架构/背景页)、developer-docs.md(README、CONTRIBUTING、ARCHITECTURE、ADR、变更日志、Runbook)、style-and-voice.md(任何重文字写作、校准项目语气)、docs-stacks.md(检测到文档技术栈、写站点页时)。

不做什么

不写营销文案、博客文章或发布公告——文档服务读者任务,不是产品漏斗;不写行内代码注释或 docstring——那是代码工作;不编造功能——代码里没有的就不进文档;不提交——它写文件并报告,由用户审核并提交。

激活时第一条回复以 📚 表情开头。