docs-chinese icon indicating copy to clipboard operation
docs-chinese copied to clipboard

关于翻译的风格规范

Open poppinlp opened this issue 7 years ago • 5 comments

注意到这个 issue 和这个 PR 中都有提及到翻译的风格规范。不如趁着这个项目目前人员很少(虽然可能也多不起来),讨论和明确一下相关规范?按照之前的经验,可能明确了之后后续的 contributor 会更加轻松一些。:)

poppinlp avatar Dec 18 '18 02:12 poppinlp

我先来抛砖引玉一下吧。

  • 所有翻译的文本内容采用 markdown 编写,支持 GMF,不熟悉的话可以参考如下链接:
    • https://help.github.com/articles/getting-started-with-writing-and-formatting-on-github/
    • https://help.github.com/categories/writing-on-github/
  • 英文夹杂在中文之间的时候,英文左右保留一个空格,例如 你好 hello 你好
  • 正文中的标点符号需要转换为对应的中文符号,例如 , => ,
    • 这里比较特殊的是中文中的顿号,在原文中出现的地方可能也是逗号
    • 英文括号修改为半角括号配空格的形式
  • 常见的缩写内容不做翻译,例如 UI, HTTP
  • 常见的框架、平台、语言等不做翻译,例如 Express, Node, Java
  • 用于表示工程代码中的一些实例不做翻译,例如 Promise, Node 中的 Request
  • 对于可能产生误解的名词翻译,如果在术语表中有,请按照对应的内容做翻译;如果术语表中未出现,那么推荐翻译后括号注解原文,例如 运行时(Runtime)

术语表:

这个我刚刚开始修改这边的翻译,之前大部分的内容都还没看,待大佬们补充。

poppinlp avatar Dec 18 '18 03:12 poppinlp

基本同意哈。这个 issue 里讨论得差不多了后,可以建个 contribution.md 的文档,收录下翻译规范和术语表。

有一点之前做的不一致的地方是:英文的括号 () 并未转换为中文括号 (),只是在两侧加上空格 ()。原因仅仅是个人觉得这样比较好看。欢迎讨论。

fralonra avatar Dec 18 '18 12:12 fralonra

  • 代码片段中的注释翻译,字符串变量不翻译

fralonra avatar Dec 20 '18 03:12 fralonra

关于括号部分,似乎几种情况都有见到有地方使用。我个人觉得分两方面。

从情境上讲,如果是在一个整体语境是中文的环境,倾向于全角括号;整体语境是英文环境,倾向于半角括号。我们这里译文应该大多数情况都是中文语境(当然我不确定是否有英文段落引用),所以倾向于前者。

考虑到具体排版的样式问题,目前这些译文的主要阅读场景(github)这边,当全角括号与全角的其他符号连接的时候,例如 哈哈哈(哈哈哈),哈哈哈,会显得很宽,看起来样式可能感觉比较难受。

这里列举了一些结合的情况,可以对比一下效果:

哈哈哈哈(hello),哈哈哈哈
哈哈哈哈(哈哈哈),哈哈哈哈
哈哈哈哈 (hello),哈哈哈哈
哈哈哈哈 (哈哈哈),哈哈哈哈
哈哈哈哈 (hello), 哈哈哈哈
哈哈哈哈 (哈哈哈), 哈哈哈哈

综上,也结合目前的使用情况,就延续半角配空格的方式吧。

顺便再补充一个

  • 中文与数字之间需要加空格,例如 2018 年 12 月 20 日

poppinlp avatar Dec 20 '18 07:12 poppinlp

术语表草稿

目前有翻译的词汇,欢迎提供更合适的翻译

  • decorator 装饰器
  • hook 钩子
  • reply 回复
  • request 请求
  • response 响应
  • scope 作用域
  • serialization 序列化

目前没有好的翻译的词汇,暂不翻译,欢迎提议

  • content type
  • media type
  • payload
  • schema

目前不做翻译的词汇

  • 用于表示工程代码中的一些实例,例如 Promise, Node 中的 Request
  • body
  • buffer
  • header
  • querystring
  • stream

fralonra avatar Jan 19 '19 08:01 fralonra