跳到正文

术语、缩写与命名

统一项目术语、官方名称、文件名与代码标识符,并维护可追溯的术语表。

保留可检索的官方写法

产品、机构和软件包采用正式名称,保留大小写、连字符和空格。例如,写作 GitHub、Node.js、TypeScript 和 Nuxt。代码中引用 useFetch、maxEntries 或 NODE_ENV 时,使用行内代码并保留字符。操作说明中的界面标签以当前版本实际显示为准。

技术术语以项目术语表为先。同义词并存时,选择能与项目界面、现有文档和源代码对应的写法。读者可能用英文检索时,在术语首次出现处按需附上原词。

按读者需要展开缩写

缩写首次出现时括注全称或简洁解释,例如“服务端渲染(SSR)”。常见的 HTTP、JSON 等可以按读者起点决定是否解释。缩写在不同语境中很容易重名,定义时交代作用,例如“文档内容协作中的 PR 指拉取请求”。

原词本指南用语备注
pull request拉取请求(PR)后文可省略全称
search index搜索索引index.json 等文件名保持原样
output directory输出目录与“源文件目录”区分
build artifact构建产物可补充具体文件类型和路径

命名文件和页面地址

为新文档使用能反映用途的短文件名。本指南用小写英文和连字符组成页面的路径片段,例如 breaking-changes。同一目录的数字前缀控制导航顺序。图片或示例文件名可包含对象和状态,例如 search-index-empty.json。既有路径改名时,核对引用与旧地址。

维护术语表

每条术语记录原词、推荐译名、上下文与适用范围。不同项目出现同一个词时,可以按项目记录各自含义。修改已有译名时,先找出标题、导航、正文和截图中的出现位置,并和译文审阅者确定可一起修改的范围。