跳到正文

中文技术写作指南

用清楚的中文说明技术概念和操作。查阅语言风格、文档结构、内容元素、术语和排版的约定与实例。

从哪里开始

先确定读者打开页面时在找什么。第一次安装的人需要前置条件和可执行的步骤,排查问题的人需要能匹配实际现象的标题,查找参数的人需要类型和默认值。根据这个任务选择文档类型,再组织正文。

用示例核对写法

原句

在完成相关配置后,可以对索引生成结果进行确认。

改写

保存配置并重新构建。构建完成后,确认输出目录中有 search-index.json。

改写补齐了操作顺序、检查位置和要找的文件。可以用可复制的模板起草页面,或读一遍完整改写案例,练习从判断读者起点到验证结果。

翻译与维护

翻译时,按译文对照实例核对原文的条件、默认值和操作顺序。发布前用审阅清单检查事实、示例和链接。想参与站点维护时,可以从首次贡献找到适合的任务。

适用范围

本指南适用于简体中文的技术说明、教程、参考和译文。涉及真实行为、接口格式和产品名称时,以目标版本的资料为准。项目已有术语表或写作约定时,优先沿用项目约定。具体规则的来源可在参考资料中按主题查找。