Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add guide for documentation-10-"开发标准" #8220

Closed
shanyi15 opened this issue Feb 7, 2018 · 0 comments · Fixed by #8803
Closed

Add guide for documentation-10-"开发标准" #8220

shanyi15 opened this issue Feb 7, 2018 · 0 comments · Fixed by #8803
Assignees

Comments

@shanyi15
Copy link
Collaborator

shanyi15 commented Feb 7, 2018

  • Task
    Here is the reclassified documentation structure, please add a guide for "开发标准", introducing what is "开发标准" , and the general idea/function/target reader of each part.

  • What is guide?
    It is an introduction of each part of one module, also, a brief introduction of this module is necessary. Take TensorFlow for example:
    image

  • Note
    Language:
    Please write in Chinese.
    Timeline:
    Draft: 1st Mar
    Review: 8th Mar
    Deadline:15th Mar
    Documentation structure mind map:
    mind map_cn
    mind map_en
    请注意
    直接改类似 doc/howto/capi/index_cn.rst的rst文件,不是新加一个md文件

  • Background

About guide, we have discussed in our MRD, see page 6

Our goal is to make it clear and understandable for developers to use.

English version is also necessary, however, our plan is writing Chinese version this time.

Thank you so much!


Project Background
Optimize documentation of PaddlePaddle, enhancing user experience
-----Enhancement Plan: Stage 1 MRD
-----Enhancement Schedule(Update everyday)
-----Guide-adding Plan

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants