社区投稿审阅指南
本指南为云原生社区成员参与官网投稿 Review 提供统一规范。主要目的为保证投稿质量,本规范主要从以下几方面规范投稿内容:
- 专业性
- 准确性
- 可读性
- 排版统一
Reviewer 标准
- 所有投稿稿件的 Reviewer 需要为相关专业资深人士。
- Reviewer 需要具备一定的技术写作经验,深谙技术文档规范,语言功底比较好。
- Reviewer 具备了相应的经验、能力和意识。
当投稿人对 Reviewer 提出的评论有异议时,有权要求审查 Reviewer 的资格。
Review 标准
稿件拒绝范围
云原生社区接受的文章投稿需要是与云原生技术相关的专业文章,不约束具体细分领域。
除以下文章不接受投稿外,原则上不拒绝其他投稿:
- 其他技术文章内容洗稿。
- 文章无实质内容,东拼西凑。
内容组织
- 正文内容是否与标题相符
- 结构上是否符合逻辑
- 结构上是否清晰明确、用户友好
- 结构上是否缺失必要的内容
- 结构上是否存在赘余
- 某部分正文是否可重新组织以更易用
- 不能包含明显的技术歧视和偏向,侧重阐述客观事实
- 提出引起思考的观点,回避可能引起争论的点
专业术语
- 专业术语符合行业通用准则
- 翻译文章的专业术语符合常用翻译规范
- 专业术语的简写符合常用的简写规范
排版规范
完整的投稿文档规范请参考 社区投稿风格指南,如果不熟悉完整的规范,可以将以下列表作为 check list。
- 语言
- 语法是否有误
- 用词是否规范
- 逻辑是否恰当完整
- 表述是否简洁易懂
- 标点
- 是否误用
- 是否漏用
- 是否中英标点混用
- 空格
- 是否多余
- 是否缺少
- 缩进
- 是否规范有效
- 无序列表
- 有序列表
- 次级列表
- 链接
- 是否有效
- 相对路径
- 绝对路径
- 图片
- 是否正常显示
- 是否需要文字说明
- 文字说明的对齐
- 图片是否有标题