Page tree

2017-07-25 Apache Spark 2.2.0 官方文档中文版发布 : http://spark.apachecn.org/docs/cn/2.2.0/


MachineLearning 优酷地址 : http://i.youku.com/apachecn

Skip to end of metadata
Go to start of metadata

页面排版

  1. 页面排版时尽量与原页面的排版一致。(不至于新手一下就看懵逼了)
  2. 创建页面时优先使用空间的默认模版。(例如,Spark 空间使用 “Spark 页面默认模版”)
  3. 正文的标题目录格式与官网的标题大小一致。(如果不知道官网的页面标题目录大小,直接在浏览器用 F12 查看代码即可)
    1. 一般情况下,不要使用 标题1,因为 标题1 就是页面的标题。(例如,该页面的 “翻译规范”)
    2. 标题的层级(最多6级标题)是为了页面的导航而使用的。
  4. 各个标题之间使用 “” (页面布局 --> 添加 )分割开。
    1. 二级标题下有多个子标题,放在一个节中即可。
    2. 特殊情况需要特殊处理。(例如,FAQ 页面)
  5. 正文若是复制的,需要在页面编辑器上选择 ”清除格式“ 以清除掉原来的格式。
  6. 标题一致性 : 
    1. 您创建页面的标题与您翻译计划中的标题不一致
    2. 您页面中的标题以及子标题与翻译计划中的标题不一致
    3. 请与翻译计划的负责人交流一下,以做到页面与翻译计划的一致性。

术语规范

  1. 术语不翻译,并且加粗。(例如,Spark)
  2. 术语前后有中文,使用空格分隔开。(例如,流弊的Spark Streaming流式处理 --> 流弊的 Spark Streaming 流式处理)
  3. 涉及到配置相关的信息,加粗(Ctrl+B斜体(Ctrl+I。(例如,配置spark.worker.cleanup.appDataTtl属性 --> 配置 spark.worker.cleanup.appDataTtl 属性
  4. `()()` 两组括号。代码中一般用 `()` 英文括号,而在翻译时,一般使用 `()` 这样的中文括号,好看点。
  5. 术语解释。例如,ML --> ML(机器学习),不要写成 --> 机器学习(ML),将术语加粗,然后再在括号里面写上相应的解释。

代码规范

  1. 代码使用代码宏引用起来。(步骤,插入 --> 其它宏 --> 格式化 --> 代码块
  2. 语法高亮选择对应的语言选项。(例如,Java 代码的语法高亮就选择 Java
  3. 主题选择 Eclipse。(直接选择 Eclipse 即可)
  4. 其它的选项根据具体场景而定吧。(例如,标题可折叠显示行号第一行号

页面修改

  1. 页面修改时一定要在 “变更了什么”  中填入您修改页面的具体信息,下面是目前一些统一的格式 : 
    1. 增加 - 您增加的内容概述。(例如,增加 - 术语规范)
    2. 删除 - 您删除的内容概述。(例如,删除 - 代码规范)
    3. 修改 - 您修改的内容概述。(例如,修改 - 代码高亮为 Java,修改 - 格式)
    4. 更新 - 您更新的内容概述。(例如,更新 - 我的个人信息)
  2. 这样方便在查询页面历史时可以看到页面历史变更的概述。

其它规范

暂无其它规范,有任何建议或者意见,可以联系 那伊抹微笑

  • No labels