Communitygithub.com

简体中文技术文档写作规范

融合阮一峰《中文技术文档的写作规范》、微软本地化与写作风格指南及ASD-STE100简明技术英语,提供统一的简体中文技术文档撰写与审校标准,并支持英文受控写作。

O que é 简体中文技术文档写作规范?

该技能汇聚了四份权威规范:阮一峰的《中文技术文档的写作规范》(侧重排版与结构)、微软的《Chinese (Simplified) Localization Style Guide》(规范本地化语气和术语)、微软《Microsoft Writing Style Guide》(传达写作理念)以及ASD-STE100简明技术英语(用于受控写作与安全关键文档)。前三份规范的完整原文备份存放在 `references/sources/` 目录下(其中阮一峰规范与 Microsoft Writing Style Guide 为 git 子模块,需初始化;MS 中文指南转换稿随仓库提供),STE 的核心思想提炼见 `references/asd-ste100-core.md`,快速自检清单见 `references/quick-check.md`。 该技能适用于编写或修改 README、教程、API 文档、发布说明、博客、产品/UI 文案、错误提示,以及将英文技术内容翻译成中文,还用于讨论中文标点、中英文混排空格、数字用法、标题层级、文档结构、语气风格,或要求简化英语(STE/Simplified Technical English/受控语言)、安全关键文档、航空与维修手册风格等场景——即使对方没有明确提及“写作规范”。它优先遵循“场景优先”、“STE 合规优先”、“一致性高于个人偏好”和“可读性高于字面对应”的冲突裁决原则,确保最终文档既符合业界标准,又易于阅读和理解。

Funciona com~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/Moemu/skills/tree/HEAD/skills/chinese-tech-writing

Perguntar na sua IA favorita

Abre um novo chat com esta habilidade de agente já pré-carregada.

Documentação

O que 简体中文技术文档写作规范 faz?

融合四份权威规范:阮一峰《中文技术文档的写作规范》(排版与结构)、微软《Chinese (Simplified) Localization Style Guide》(本地化语气与术语)、微软《Microsoft Writing Style Guide》(写作理念)、ASD-STE100 简明技术英语(受控写作与安全关键文档)。前三份完整原文备份见 references/sources/(阮一峰规范与 Microsoft Writing Style Guide 为 git submodule,需初始化;MS 中文指南转换稿随仓库提供),STE 核心思想提炼见 references/asd-ste100-core.md,自检清单见 references/quick-check.md。

三个基本理念(微软 voice)

写每一个句子前先记住:先扫读,后阅读。读者通常是扫一眼找答案,不是逐字阅读。

  1. 温暖自然——像跟同事说话,不像写公文。用日常用语,少用书面腔。
  2. 简洁清晰——能用短句就不用长句,能删的词都删。短即是好。
  3. 乐于助人——站在读者一边,告诉他下一步做什么,而不是堆砌事实。

硬性排版规则

这些规则几乎无争议,写中文技术内容时始终执行:

中英文混排空格

  • 中文字符与英文单词之间留一个半角空格:本文介绍如何快速启动 Windows 系统。
  • 中文与阿拉伯数字之间:加不加空格都可以,但全文必须统一(本规范推荐加空格)。
  • 数字与英文单位之间留空格:16 GB;数字与百分号、中文单位之间不留:6.5%、1000 元。
  • 英文/数字与全角标点之间不留空格:他的电脑是 MacBook Air。(不是 MacBook Air 。)

标点符号

  • 中文语句用全角标点(,。:;?!""''()、《》);整句是英文时用半角标点。
  • 冒号:文档正文用全角:;软件 UI 字符串用半角: (后跟一个空格),如 错误: %1。
  • 问号/叹号:文档用全角?!;软件 UI 用半角? !。
  • 并列词语用顿号、,即使并列项是英文:Google、Facebook、腾讯,最后一项用和连接。
  • 引用用全角双引号"",引号内再用引号时外双内单''。
  • 括号补充说明用全角(),括号前后不加空格;括号内是纯英文/数字时可用半角()。
  • 括号加注时句号在括号外:请参照第 1.3 节(见第 26 页)。
  • 省略号:文档正文用中文省略号⋯⋯(占两格六点,不用...或。。。);UI 字符串用英文...。
  • 省略号不与等连用:要么香蕉、苹果、梨⋯⋯,要么香蕉、苹果、梨等水果。
  • 感叹号尽量避免;不得连用(!!禁止)。
  • 破折号占两个汉字位置:————。
  • 数值范围用~或—:132 kg~234 kg;两数单位不同时都带单位。
  • 复合词与编号用半角连字符:氧化-还原反应、图 1-1。

数字

  • 一律用半角数字,不用全角100。
  • 千位及以上加千分号:1,258,000;4 位数可加可不加,但全文统一。
  • 货币用符号或中文名:$1,000 或 1,000 美元。
  • 增加到表示达到量,增加了表示增量;禁止降低 N 倍/减少 N 倍,改用降低/减少百分之几。
  • 量词要具体,不要一律用个:两位研究人员优于2个研究人员。

句子与段落

  • 句子尽量短:无标点单句 20 字以内最佳,超过 40 字不可接受;逗号连缀的长句不超过 100 字或 3 行。
  • 用简单句和并列句,避免复合长定语(名词前不要堆太多形容词)。
  • 用肯定句不用否定句:请确认装置的电源已关闭,而不是请确认没有接通装置的电源。
  • 禁止双重否定:用户必须拥有删除权限,才能删除此文件,而不是没有删除权限的用户,不能删除此文件。
  • 用主动语态不用被动语态:假如尚未安装这个软件,而不是假如此软件尚未被安装。
  • 一个段落只有一个主题;中心句放段首;段落不超过 7 行,4 行以内最佳;段落间空一行,段首不缩进。
  • 正确使用的/地/得:形容词+的+名词;副词+地+动词;动词+得+补语。
  • 少用的:不影响含义就删掉,一句话里两三个的就会显得拖沓。
  • 代词(其/该/此/这)指代必须唯一明确;能省略代词就省略(微软:不必把每个 your/it 都译成你的/它)。

语气与用词(微软 voice 的中文落地)

  • 用"你"不用"您"——微软全系列产品一致;亲切但不轻慢。
  • 直接称呼读者、给出动作:密码有误,请再试一次优于密码不正确。请输入正确的密码。
  • 避免过度书面的词:用如果不用倘若/假使/若要;用到不用至(添加到网络);用总之不用总而言之;用只是不用仅是。
  • 避免生造词、文言腔和网络流行语:禁止给力、山寨、亲、神马、偶、童鞋、酱紫;粉丝、菜鸟(限游戏语境)、量身打造可接受。
  • 不用最好、最强、唯一这类绝对化形容(广告法风险 + 微软 voice 要求)。
  • 性别与包容性:泛指时避免他,改用其、省略代词或指称角色(读者、用户、客户);禁用剩女、娘炮、老外、残废等歧视词,用大龄青年、残障人士、外国人。
  • 写无障碍相关内容时选择优于点击(兼容键盘、触屏等输入方式)。
  • 避免逐词直译。先理解整段意图,再像自己写中文一样重组,必要时删掉不影响含义的修饰语。

英文与术语处理

  • 英文词汇第一次出现时括注中文:IOC(International Olympic Committee,国际奥林匹克委员会),之后直接用缩写。
  • 英文复数还原为单数:RAMs→RAM;缩写字母全大写。
  • 英文书名/电影名改用书名号《》;...在中文语境改为⋯⋯。
  • 产品名、商标、键名不翻译:Windows Server 2022(不缩写为Win Server 2022)、Visual Studio 2022(不用VS 2022);Ctrl、Alt、Enter、Esc、Tab等键名保留英文且不加键字(按 Ctrl+Alt+Del)。
  • 方向键译为向左键、向上键等。
  • 快捷键格式:翻译文本(&大写字母),如退出(&E);放在标点之前:搜索(&S):。
  • 时段划分:凌晨 0:00–5:59、上午 6:00–11:59、中午 12:00–12:59、下午 1:00–17:59、晚上 18:00–23:59。
  • 同一术语全文保持同一译法(app→应用,application→应用程序;select→选择,pick→选取)。
  • 正在进行时用正在…:Uploading…→正在上载…;但章节标题Using …是使用…不是正在使用…。

标题层级与文档结构

  • 标题最多四级;一级标题下不能直接出现三级标题;不出现孤立编号(同级只有一个就不设层);下级标题不与上级同名;尽量不用四级标题,改用**(1)(2)**加粗列表。
  • 标题末尾不放句号、逗号、顿号(问号叹号书名号可以)。
  • 软件手册推荐结构:简介[必备] → 快速上手[可选] → 入门篇(环境准备/安装/设置)[必备] → 进阶篇[可选] → API[可选] → FAQ[可选] → 附录(Glossary/Recipes/Troubleshooting/ChangeLog/Feedback)[可选]。
  • 文件名:小写、半角、无空格、连词线分隔(advanced-usage.md,不用advanced_usage.md;README、LICENSE例外可大写;中文不能用于文件名)。

UI 文案与错误消息

  • 先说结论/问题,再说动作;一句话一个意图。
  • 用句子片段更干脆:步骤如下:优于请执行以下步骤:;如图所示:优于请参阅下面的图像:。
  • 错误消息套用标准短语:Cannot find/Unable to find→无法…;内存不足,不直译没有足够的内存;不可用→无法使用…。
  • 占位符%d/%s等不可改写,翻译后要保证语法通顺:%d users are online→%d 位用户在线(补量词)。
  • 语气温和友好,不指责用户,不说教。

ASD-STE100 约束(受控技术英语)

适用于:明确要求 STE 合规的文档(航空、军工、机械维护等安全关键手册)、需要机器翻译/LLM 流水线稳定处理的英文源文,以及一切操作步骤与安全提示的写法。完整规则体系见 references/asd-ste100-core.md(原标准为付费版权规范,此处只保留核心思想)。

写英文 STE 合规文本时的硬规则:

  • 词汇只用三类:STE 词典批准词(一词一义、一词一性)、技术名词(TN)、技术动词(TV);词典外的词只有归入公司/行业批准的 TN/TV 才可用。
  • 动词只用简单形式:不定式、祈使式、一般现在/过去/将来时、过去分词(仅作形容词);禁止进行时、完成时与助动词堆叠;"-ing" 只作技术名词或其修饰语。
  • 复合名词最多 3 词;更长时先写全称再给缩略式或加连字符。
  • 美式拼写;禁用缩略词(do not 而非 don't);禁用分号;不省略主语、动词、冠词;术语与措辞永远一致。

写操作步骤与安全提示时(中英文都适用,这是 STE 对本技能最普适的贡献):

  • 每句一个动作;条件前置、逗号分隔,再给命令。
  • 垂直列表代替复杂长句;Note 只给信息不带指令。
  • 安全提示三段式:WARNING(人身伤亡风险)/CAUTION(设备损坏风险)+ 命令或条件 + 风险后果;等级选错比不写更糟,两种风险并存时升为 WARNING。
  • 描述文每句 ≤25 词、每段 ≤6 句、每段一个主题、信息逐层给出。

STE 的词汇规则不适用于中文,但其精神融入本技能其余章节:术语唯一、短句量化(程序文 ≤20 词→中文每步一个动作)、不名词化("进行检查"→"检查")、拆句不删词。

冲突裁决(多份规范不一致时)

  1. 场景优先:技术文档/教程/README 按文档规范(全角标点、省略号⋯⋯);软件 UI 字符串/错误消息按软件规范(半角冒号+空格、半角? !、省略号...)。
  2. STE 合规优先:明确要求 STE 的英文文本,以 STE 53 条规则为准(词汇、时态、句长),微软 voice 与通用英文规范服从之。
  3. 一致性高于个人偏好:数字与中文之间加不加空格、4 位数加不加千分号,规范允许可选时,选一种并全文坚持。
  4. 可读性高于字面对应:直译生硬时重写(微软 voice 明确授权改写);省略号与等、至等具体冲突按上文"硬性规则"执行(文档场景以阮一峰规范为准)。
  5. 本规范未尽事宜按顺序查阅:references/quick-check.md → references/asd-ste100-core.md → references/sources/ 下对应原文(其中两份 submodule 需先初始化)。

审校流程

交付中文技术文档前,按以下顺序过一遍:

  1. 排版:中英文空格、全角半角标点、数字千分号。
  2. 句子:长句拆短、否定改肯定、被动改主动、双重否定消除。
  3. 语气:您→你、书面腔口语化、删多余的的、检查指代。
  4. 术语:首现括注、译法统一、产品名键名未翻译。
  5. 结构:标题层级合法、段落主题唯一、文件名合规。

细节正误对照表见 references/quick-check.md。

Habilidades Relacionadas