跳转到内容
关系图谱

technical-writing(pstack)

377 字 1 分钟

属性 8
repo
pstack
skill
technical-writing
source
pstack/skills/technical-writing/SKILL.md
invoke
user
phase
ship
cost
low
status
stable
local
missing
一句话

四层写作标准:Diátaxis 选文档模式,Google developer style 管句子,STE 管指令,Global English 管歧义;目标是疲惫的工程师一遍读懂。

何时用 ​

  • 适合:写或审 docs、RFC、README、PR 描述、commit message。
  • 不适合:产品 UI 文案(走产品自己的文案规范);只清 AI 腔用 pstack-unslop。

怎么用 ​

text
/technical-writing 审一遍这次 README 改动
  1. 先选 Diátaxis 模式:tutorial / how-to / reference / explanation,一文档一模式,不混。
  2. 句子按 Google 风格:对读者说 you、现在时、指令用命令式、条件放指令前、常见情形在前。
  3. 指令按 STE:一句一个指令一个想法,长句拆开,警告在步骤前,一词一义。
  4. 歧义按 Global English:only/not 贴紧所饰词,代词只指一物,不用分号、斜杠、缩写括号。
  5. 三条总规则压顶:不做事的词全删,用日常短词,规则让句子变糟就换写法或放过它。

产出 ​

  • 按所选模式改好或评审过的文稿;PR 描述和 commit message 除 Diátaxis 外全层适用。

要点与坑 ​

  • 词汇表就是代码库:写真实符号、路径、命令名;别造行话,发现新的抽象隐喻词应提议加进 pstack-unslop。
  • 还要「vary the rhythm」:条条合规但每句一样短一样干,仍算机器腔。
  • 纯方法技能,任何宿主可用;与本仓库 pstack-unslop 分工:unslop 管 AI 模式清单,本技能管完整文档标准。

关联 ​