Skip to content

Commit

Permalink
English doc writting requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
chenjiandongx committed Aug 1, 2017
1 parent 7405818 commit 691154a
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions document/requirements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# 英文文档的编写要求

[@chfw](https://github.com/chfw) 已经提交了文档的第一个 PR,希望大家可以后续跟进,将本地仓库同步到最新后就可以继续编写。最重要一点是请及时提交 PR,保持项目的最新状态。我会在第一时间内审 Merge 的。内容的话就参照中文文档的编写吧,编写风格尽量保持一致。如果大家有更好的想法,如增加某部分更加详细的介绍,更好的例子,更好的排版建议,也可以具体体现在英文文档中。

### 项目中的示例
项目里面的示例基本上都是采用中文的例子,所以示例这部分也要修改。可以将示例改成更适合英语阅读者习惯和感兴趣的。新的图片就上传到 images-en 文件夹里吧。图片命名要求与 images 里面的一致,如 bar-0, scatter-0。整齐统一,方便管理。(图片大小建议不要超过 10M)

### 愿大家工作愉快!

0 comments on commit 691154a

Please sign in to comment.