开局与约定

中文技术文档排版与术语规范

中文技术文档与产品文案的写作规范技能:直角引号、中英文留白、黑话禁用、API 状态词,附可进 CI 的 lint 脚本。

看它做了什么

何时用

项目产出面向读者的中文文档(文档首页、API 说明、操作手册、FAQ、界面文案),需要立排版与术语规矩:直角引号「」、中英文与数字之间加空格、一段一行、黑话禁用表、API 状态词不机械直译。判据是两条之一:排版术语问题靠人眼 review 已管不过来(PR 反复挑引号和空格),或要在 CI 里对 .md 做机械检查(自带零依赖 Python 检查器,error/warning/style 分级)。

不装技能、只想临时用一次:复制下方「使用 prompt」整块贴进任意聊天窗口即可,规则自包含,当次会话生效。

它管「格式与术语」,不管「像不像 AI 写的」。排好了版但读者嫌 AI 腔的,走去味技能(sepia/sdlc-deai-zh),两者分层可同装,但须在 AGENTS.md 写明分工。不适用:英文文档(claude-prose-style 的域);内部一次性笔记与代码注释;机器可读内容(代码字面量、JSON 键名、URL,上游规则自己排除)。

这一版怎么样(0.3.2)

评估基于 v0.3.2(2026-09-29 发布),实际读过 SKILL.md、references/terminology-and-typography.md 全文,并把仓库克隆下来跑了检查器与本库 49 个 .md:

  • 检查器实测可用:对本库跑出 error=0、warning=2、style=605。两条 warning 都是语境词误报(「标示时点」的动词用法正确);605 条 style 集中暴露一处真实问题——本库 stages/ 与 docs/ 大量混用 "中文" 与 「中文」。一次运行就把排版欠账量化了,这是多数写作技能给不了的验收手段。
  • 规则设计克制:事实保真排在优先级第一(不增删事实、不确定表达不许改成确定);黑话表分两级——「确认后才可用」(赋能、抓手、闭环)与「依赖语境不由检查器自动替换」(场景、生态、梳理),比一刀切禁词可用。
  • 风险一:SKILL.md 的触发描述覆盖「撰写、改写、校对、审阅」全部中文文档任务,不写边界会与项目里其他写作类技能抢触发。风险二:style 级建议噪音大(本库 605 条里大部分是示例文本与设计文档的引号),进 CI 只把 error 设为阻塞、style 走白名单,否则第一次跑就会淹没团队。风险三:受控中文模块借鉴 STE 思路,上游自己声明不表示符合 ASD-STE100。

待验证(本卡未实测):技能常驻后与 deai-zh 同装时的实际触发竞争;lint 脚本在 CI 的长期维护成本。

使用 prompt

复制整块,贴进任何 agent 的聊天窗口,当次会话生效,无需安装。规则提炼自上游 v0.3.2 的 SKILL.md 与四个 references,自包含:

【中文技术文档排版与术语规范】会话级启用:直接粘贴,无需安装
(规则提炼自 Fenng/Tech-Doc-Style-Chinese v0.3.2,MIT)

从本条消息起,你在本次会话中按以下规则处理中文技术内容。冲突时按此优先级:
事实与限制 > 我的明确要求与项目约定 > 术语准确 > 结构语气 > 排版细节。

0. 先判定任务模式,再动手:
   - 撰写:先确认受众、内容类型、事实来源与篇幅;缺会改变结论的事实时
     先标记缺口,再组织可确认内容。
   - 改写:交付完整改写稿;重大语义选择与待确认内容单独说明。
   - 校对:只改错字、标点、留白、大小写与术语一致性;不动结构与事实。
   - 审阅:先列问题(按影响排序、引用具体原文),未经授权不直接改。

1. 事实保真高于一切:不新增原文没有的日期、数字、时限、能力、条件、因果
   与结论;不删除前提、限制、例外、警告与失败处理;「可能/计划/通常」
   的确定程度保持原样;信息不足标〔待确认〕,不自行补全。

2. 语义与语气:准确先于修辞;克制、直接、可执行;优先说清「是什么、适用
   于什么、需要做什么、接着看哪里」;不要问候式开场、宣传口号、空泛形容;
   默认不称呼读者,需要时用明确角色(开发者/实施人员)。

3. 结构与句子:一段一个主要信息点;一句一个主干,不连续堆叠条件、动作与
   例外;列表项保持同层级同句式;删重复信息,但不删事实、条件与例外;
   指代可能不清时用具体名称替代「该/其/此/上述」。

4. 排版(只作用于可见正文):
   - 引号用直角引号「」,嵌套用『』;作品名用《》。
   - 中文与英文、数字、版本号之间加一个半角空格:使用 API 获取数据、
     等待 3 秒;行内代码两侧各加一个半角空格;全角标点前后不加空格。
   - 中文说明用全角括号();省略号用……;破折号用——。
   - 段落保持一段一行,不为控制行宽硬换行。

5. 术语:同一概念始终用同一术语,不为变化换同义词;缩写首次出现给全称。
   高频黑话换成具体说法:赋能→提供(或直接写能力)、抓手→关键措施、
   闭环→完整流程、沉淀→积累/保存、对齐→统一/确认一致、拉通/打通→
   连接、洞察→分析结论、兜底→写明失败后的具体保障、落盘→写入文件、
   透传→原样传给下游。有明确定义、属正式术语或引用原文时保留,并在首次
   出现处说明含义。「场景/生态/梳理/复盘」等语境词不自动替换。

6. API 与错误文案:英文状态词按语义选中文,不做固定映射——Success→
   已完成/请求成功;Invalid→无效/格式有误(不译「非法」);Unauthorized→
   未登录/认证未通过(不译「未授权」);Not Found→未找到对应数据;
   Bad Request→请求参数有误;Pending→待处理;Timeout→请求超时。
   错误文案按序说清:发生了什么、哪个对象受影响、可能原因(不把推测写
   成确定原因)、可执行的恢复操作、仍失败时需要提供的诊断信息。

7. 操作与排查文档加受控写法:一步一个主要动作,动作对象写具体(不只写
   「处理/操作」);前置条件与风险放在动作之前;区分人工操作与系统自动
   行为;排查从低风险、可逆、证据价值高的检查开始。

8. 机器可读内容一律不改:代码、命令、URL、JSON 键名、数据库字段名、
   状态码、枚举值、配置项与我指定的字面量。

执行要求:
- 先用两三行复述你理解的任务模式与边界,确认后再处理我发来的内容。
- 改写或校对完成后,列出你命中并执行了的规则编号,便于我核对。
- 不适用:英文文本、创意写作与品牌文案、内部随手笔记;让文字「不像 AI
   写的」不是本规则的目标。
- 本 prompt 只在会话内生效。

确认是否生效:发一句「通过一站式能力赋能团队快速完成数据处理」。按规则应得到类似「平台集中提供数据处理功能,帮助团队快速完成数据处理」的平实改写——黑话被替换、原句已有的「快速」主张保留、不补速度指标。

安装 prompt

复制整块,贴进目标项目的 agent 会话。prompt 描述结果而不写命令,任何 agent 都能执行:

请让 tech-doc-style-chinese(中文技术文档规范技能)在本项目可用,按 1→5 顺序做完再继续别的事:

1. 【检测】检查两个级别的安装状态,只报告结论:
   - 用户级:~/.claude/skills/tech-doc-style-chinese/
   - 项目级:.claude/skills/tech-doc-style-chinese/、.agents/skills/tech-doc-style-chinese/
   结论写清:装了/没装;装了则版本号是多少、从哪个文件读到。上游不在
   SKILL.md 里写 version 字段,若目录里没有版本记录(如克隆时的 tag 或
   安装清单),如实说明读不到,不要猜。

2. 【对版本】已安装时:从
   https://github.com/Fenng/Tech-Doc-Style-Chinese/releases 查最新 tag,
   与第 1 步读到的本地版本比较。
   - 一致 → 不动它,说明判断依据。
   - 读不到本地版本 → 如实说明,不要猜。
   - 落后 → 升到最新,升级后重新确认。

3. 【安装】未安装时装最新 tag。把 SKILL.md、references/、scripts/
   三个部分都装进来(检查器在 scripts/ 里,漏掉会丢掉 CI 校验能力),
   放入 .claude/skills/tech-doc-style-chinese/。Claude Code 用户可改用
   npx skills add(附注即可,不是唯一路径)。

4. 【加载确认】确认技能本会话真的可用:它的触发描述应出现在你的可用
   技能里。新装技能在当前会话不可见时,不要装作可用,要告诉用户怎么让
   它生效(通常是重开会话),然后停下等确认。

5. 【边界】在本项目 AGENTS.md(没有则创建)追加下面这一节。若已存在
   同名小节则整节替换,不要重复追加:

## Chinese tech doc style (tech-doc-style-chinese)

- Use tech-doc-style-chinese for typography and terminology of
  reader-facing Chinese docs: corner quotes, CJK-Latin spacing,
  one-paragraph-one-line, jargon blocklist, API status wording.
- It does NOT de-AI prose; that stays with the de-AI skill (sepia or
  deai-zh). When both are installed, this skill owns format/terminology
  and the de-AI skill owns voice.
- The lint script reports error/warning/style levels; only `error`
  blocks CI. `style` findings are advisory and need a project
  allowlist, otherwise first run drowns the team.

完成后:列出改动或新增的文件,并给出第 1–4 步每步的结论。

确认方式:给 agent 一段含「赋能」「抓手」和「使用API获取数据」的中文文档片段,让它按规范处理。装对了会给出黑话的平实替换(赋能→提供)、在中英文间补空格(使用 API 获取数据),但不改动事实、数字与代码字面量;顺手重写整段、删掉限制条件或改掉数字的,都是没装对。

版本

本库不记录上游当前版本号,只记录评估时基于的那一版(见 frontmatter 的 evaluated_version)。上游当前版本由 GitHub Releases 管理,查询方式:https://github.com/Fenng/Tech-Doc-Style-Chinese/releases。

评估历史:0.3.2(2026-09-30)