基础工具与工作流 · cursor/plugins

technical-writing

Layered technical-writing standard: Diátaxis structure, Google developer style sentences, STE instruction rules, Global English syntax. Use for /technical-writing or when writing or reviewing docs, RFCs, readmes, PR descriptions, or commit messages.

风险提醒:绿色 · 放心使用AI 侦查报告
作者 cursorGitHub cursor/plugins ↗Stars 7221许可 仓库根无统一 LICENSE(GitHub API license 为 null);该 skill 随 pstack 插件分发,插件自带 pstack/LICENSE(MIT,Copyright (c) 2026 Lauren Tan)commit df3fb154fb
agent 宿主通常会约束 skill 执行权限;风险提醒为 AI 侦查观点,不构成质量或安全保证。第三方 skill 仅作拆解与展示,安装使用风险自负,版权归原作者。

1实现原理 · 为什么它能做到

四层写作标准叠加、每层一问:文档类型(Diátaxis)→ 句子面向读者(Google developer style)→ 单句承载量(STE)→ 消歧(Global English),逐层收窄到『一读就懂』。

pstack/skills/technical-writing/SKILL.md
The goal is writing a tired engineer understands on the first read. Four layers get you there, one question each: what kind of document is this, how do sentences address the reader, how much does each sentence carry, and can any sentence be read two ways. Apply all four.
注:四层不是并列清单而是递进约束:先定文档种类,再管句子人称/语态,再限每句信息量,最后消灭歧义读法。

层之上先立三条总规则:删无功能词、用短常用词、规则让句子更差时改句子而非硬守规则——规则服务于读者而非机器味。

pstack/skills/technical-writing/SKILL.md
- **Cut every word that does no work.** If the sentence survives without a word, the word goes. "In order to" is "to". "It is important to note that" is nothing.
注:同段第三条 'When a rule makes a sentence worse, fix the sentence another way or leave it alone…A sentence that follows every rule and sounds like a machine wrote it has failed.' 是这套标准防止教条化的安全阀。

Diátaxis 模式分流:用『指导行动还是增进理解 × 服务学习还是工作』两问把每份文档归入 tutorial/how-to/reference/explanation 之一,禁止混模式,跨模式用链接切分。

pstack/skills/technical-writing/SKILL.md
One document, one mode. Two questions pick it: does the content inform action (doing) or understanding (thinking), and does it serve learning or work?
注:每种模式给出口语化行为规范(tutorial='we'+命令式+早期可见结果;how-to=只写操作;reference=只描述不劝说;explanation=唯一允许观点的地方),并以 'Don't mix modes: no reference tables inside a tutorial…Split and link instead.' 收口。

句子层规则直接搬运三家外部规范并把来源与抓取日期写进正文:Google developer style(developers.google.com/style)、STE 受控语言(asd-ste100.org Issue 9 2025)、Global English(Kohl, SAS Press——经 Internet Archive 与 SAS 样章转写),均在撰写期抓取、非运行时调用。

pstack/skills/technical-writing/SKILL.md
Source: diataxis.fr, fetched 2026-07-18.
注:四处来源各带 'Source: … fetched 2026-07-18.' 行(diataxis.fr、developers.google.com/style、asd-ste100.org、Kohl 书);STE 自述 'The numbered rules and dictionary live in the spec PDF. The principles above are the transferable core.'——诚实交代只转写了可迁移核心。

仓库词汇纪律:『codebase 就是词表』——写真实符号/文件/命令名,禁止自造行话与比喻词;发现新违禁词不得直接改 unslop,而是把『违禁词→替换词』连同 diff 作为提案写进回复。

pstack/skills/technical-writing/SKILL.md
The codebase is the word list. Write the real symbol, file, flag, or command name, not a synonym or a description of it.
注:协作边界清晰:'Propose a new offender and its replacement as an addition to `unslop`'s abstract-metaphor rule in your reply, with the diff. Don't edit that skill.'——词表归 unslop 所有,本 skill 只提案。

与 unslop 硬绑定并扩展覆盖域:凡本 skill 触碰的文档都要再过 unslop(AI 腔/填充词/格式 tell 的目录);PR 描述与 commit message 也是写作对象(除 Diátaxis 外全层适用)。

pstack/skills/technical-writing/SKILL.md
- Apply the **unslop** skill to every doc this skill touches. That skill owns the slop-pattern catalog: AI vocabulary, filler, hedging, formatting tells.
注:把『文档质量』从正文扩展到工程痕迹:'PR descriptions and commit messages are writing too…A PR body is a briefing that a reviewer can read in under a minute.'

提供 worked example(Before/After 改写示范)与 8 条评审清单,把抽象标准落成可直接执行的验收问题;声明性规则要求『数字/路径/计数在落地的 commit 上为真,并附可再生的命令』。

pstack/skills/technical-writing/SKILL.md
Make every count or tree claim true at the commit that lands it, and include the command that regenerates it.
注:Before/After 例把一段塞满被动语态与空话的配置说明改写成三句带真实命令的陈述;Review checklist 8 条(模式单一/命令式/一句一义/可删词/指代歧义/一名一物/口语词/符号与计数真实)。

2核心能力

01文档类型分诊:Diátaxis 四模式单选 + 禁止混模式 + 跨模式链接
02句子层规范:you/现在时、施动者明确、命令式、条件前置、禁用『simply/easy/quickly/please』等
03STE 受控语言:一句一义、超长句切分、保 the/a 消歧、一词一义、程序直陈命令式、少用 -ing
04Global English 消歧:only/not 邻接、断名词串、指代唯一、保结构小词、禁斜杠与缩写、一名一物
05节奏与观点控制:长短句交错、一句一义≠一句一长、模式允许处要有观点、具体优于无菌
06真实符号纪律 + unslop 联动 + PR/commit 覆盖 + worked example + 8 条评审清单

3外部依赖

类型依赖
network内容来源引用(撰写期抓取的知识来源,非运行时调用):diataxis.fr
network内容来源引用(非运行时调用):developers.google.com/style
network内容来源引用(非运行时调用):asd-ste100.org(STE 规范 Issue 9, 2025)
network内容来源引用(非运行时调用):Kohl《The Global English Style Guide》(SAS Press,经 Internet Archive/SAS 样章转写)

4风险提醒 风险提醒:绿色 · 放心使用

风险提醒:绿色 · 放心使用
  • 规则密集且部分高度具体,机械执行会产出『全对但僵硬』的文字;纠偏依赖模型对『机器味=失败』的判断。 — 'A sentence that follows every rule and sounds like a machine wrote it has failed.' 需模型自主执行
  • 规范快照会过时:引用的 STE Issue 9 (2025)、Google style 等均为 2026-07-18 静态抓取,后续修订不会自动同步。 — 四层来源均为转写而非运行时引用
  • 跨 skill 依赖 unslop:若宿主未安装/未启用 unslop,『Apply the unslop skill to every doc』会静默失效(skill 自身无降级提示)。 — 同仓库 pstack/skills/unslop 存在但非本 skill 自带
风险提醒:绿色,放心使用。纯指令型 skill:无脚本执行、无网络外发、无凭证读取、无本地写入,运行期零 IO(四层规范与示例全部内联在 SKILL.md);且 disable-model-invocation: true 仅用户显式调用(/technical-writing 或写作/审阅触发)。注意点仅为规则机械化的文风风险与静态知识来源的时效性,不构成代码级风险。

5第二遍独立确认

  • [ok] 单文件零资产 — 技能目录仅 SKILL.md(含隐藏文件 glob 确认),无 references/scripts/data。
  • [ok] 四层标准与 description 对应 — 正文标题/内容与 description 四层(Diátaxis structure / Google developer style sentences / STE instruction rules / Global English syntax)一一对应;每层均给独立规则块与来源行。
  • [ok] 来源引用为静态文字、非运行时调用 — 4 处 'Source: … fetched 2026-07-18.' 均为引用标注;无 urlopen/curl/requests 等运行时拉取代码。
  • [ok] 规则内容与所引规范一致(抽样) — Google style 段 'Talk to the reader as "you", in the present tense.'、STE 段 'Split instructions longer than about 20 words and other sentences longer than about 25.'、Global English 段 'Break up long noun strings' 等与规范主旨相符;并如实声明 STE 只转写可迁移核心、完整规则在 PDF。
  • [ok] unslop 联动指向真实资产 — pstack/skills/unslop/SKILL.md 存在(glob 确认);SKILL.md 明确 'That skill owns the slop-pattern catalog'——职责划分与仓库结构一致。
  • [ok] 无运行时 IO/凭证/写入 — token 扫描仅命中来源标注行;全文无 shell/网络/文件命令。
  • [ok] 夸大检查 — 'writing a tired engineer understands on the first read' 是质量标准陈述而非可测功能承诺;worked example 与 checklist 均可直接执行,无越界承诺。
  • [ok] license/stars/commit 元数据 — GitHub API:cursor/plugins stars 7221、pushed_at 2026-09-09T08:18:30Z、license null(仓库根);pstack/LICENSE 为 MIT(Copyright (c) 2026 Lauren Tan);本地 git HEAD == pin df3fb154fb982fb83f649de8646d4af6a0cb16b3。

6结论

  • 把四套权威写作规范收敛成一套可逐层执行的单一标准,且给每层配了『一句话问题』降低应用门槛。
  • 来源透明:每条规范带出处与抓取日期,读者可回溯核对;对无法全文转写的 STE 如实声明只含可迁移核心。
  • 反教条安全阀(规则让句子更差就换写法)使标准可用在真实写作而非只过 lint。
  • 工程痕迹全覆盖:PR/commit 也被纳入,配合 unslop 词表与『计数在 commit 上为真』,直接提升代码评审文本质量。
  • 零 IO 零依赖,可整目录搬移到任何宿主;Before/After 实例把抽象标准落到可模仿的具体形态。
  • 适合:适合把文档、RFC、README、PR 描述、commit message 当作一等交付物的工程团队与个人;适合想统一多规范写作风格的 skill 作者参考其『分层+溯源+实例』写法;适合接入已有编码纪律(unslop/poteto-mode 家族)的会话。
    不适合:不适合需要自动改写/批量润色流水线的场景(纯标准无执行能力,须由 agent 人工应用);不适合追求营销/创意文案的场景(标准面向技术文档,观点只允许在 explanation 模式);不适合需要实时联网查最新规范版本的场景(知识为静态快照)。
    安装 agent 直装可复制
    ① 本站镜像 更新 2026-09-09
    方式 A · 人下载镜像包下载 technical-writing.tar.gz
    sha256: bf0a9d23048af4b7…
    方式 B · JSON 格式安装指南,复制给 agent
    安装指南
    agent 读 JSON 指南后会自动从本站下载安装,无需更多说明。
    ② 上游 GitHub · 原始来源
    能访问 GitHub?直接去上游安装(实时版,可能已更新)GitHub 原始 ↗
    本页镜像锁定 commit df3fb154fb;上游为实时仓库。
    来源信息 GitHub 原始
    作者 / 仓库cursor / cursor/plugins
    原始 GitHubcursor/plugins ↗
    Stars7221
    最近推送2026-09-09
    本 skill commitdf3fb154fb
    许可仓库根无统一 LICENSE(GitHub API license 为 null);该 skill 随 pstack 插件分发,插件自带 pstack/LICENSE(MIT,Copyright (c) 2026 Lauren Tan)
    本站信息
    收录日期2026-09-06
    分类基础工具与工作流
    侦查报告AI 侦查 · 2 遍 · 2026-09-06
    本站镜像与 GitHub 原始是不同来源:本站锁定 commit 快照经 /r2 分发;GitHub 为实时上游,内容可能已更新。
    同分类邻近