【Hackathon No.70】 #54
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
TCChenlong
reviewed
Mar 21, 2022
|
你的PR有最新反馈，请及时修改。 |
|
已经依据 comments 做了更新， 麻烦有空继续 review 下 @TCChenlong |
TCChenlong
reviewed
Mar 21, 2022
rfcs/Docs/20220320_docs_eval_docs.md
Outdated
|
|
||
| 本报告将预计基于以下几方面的体验形成文字： | ||
|
|
||
| 1. 假定用户是新手上路：用户简单了解 PyTorch 后者其它框架，但是还未接触过飞桨，对深度学习的了解也有限，他如何从飞桨文档官网上获取信息上手飞桨。 |
rfcs/Docs/20220320_docs_eval_docs.md
Outdated
| 本报告将预计基于以下几方面的体验形成文字： | ||
|
|
||
| 1. 假定用户是新手上路：用户简单了解 PyTorch 后者其它框架，但是还未接触过飞桨，对深度学习的了解也有限，他如何从飞桨文档官网上获取信息上手飞桨。 | ||
| 2. 假定用户是初中级算法工程师：用户已经掌握深度学习的基础技能，现有利用 Paddle 搭建模型进行训练、不熟等任务的需求，或者有迁移模型的需求。他如何依据飞桨文档官网上的信息，完成任务，并验证正确性。 |
rfcs/Docs/20220320_docs_eval_docs.md
Outdated
|
|
||
| 1. 假定用户是新手上路：用户简单了解 PyTorch 后者其它框架，但是还未接触过飞桨，对深度学习的了解也有限，他如何从飞桨文档官网上获取信息上手飞桨。 | ||
| 2. 假定用户是初中级算法工程师：用户已经掌握深度学习的基础技能，现有利用 Paddle 搭建模型进行训练、不熟等任务的需求，或者有迁移模型的需求。他如何依据飞桨文档官网上的信息，完成任务，并验证正确性。 | ||
| 3. 假定用户是开源爱好者：当用户想自发地位飞桨的文档做贡献时，他如何依据飞桨公开的信息，获取到他能参加哪些活动，如何参与到飞桨的开源建设中来。 |
rfcs/Docs/20220320_docs_eval_docs.md
Outdated
| 报告形成的维度包括： | ||
|
|
||
| - 文档的宏观组织：依据 https://documentation.divio.com/ 中的文档四象限理论，与其它主流框架做对比，讨论飞桨的文档组织的特点 | ||
| - 文档的内容：与其它框架做对比，综合各个框架，看怎样是“完备”的信息，并讨论飞桨的完备度和特点 |
There was a problem hiding this comment.
这里“完备”的信息是一方面，还有一方面是不同类型的文档的文档结构特点以及优势等；如指南类、实践类、API文档类的文档写作风格各不相同
There was a problem hiding this comment.
谢谢，已经根据建议增加一个维度“文档的风格特点”
|
最近一次的 comment 提出的建议已经修改。麻烦有空时继续 review 下 @TCChenlong |
TCChenlong
approved these changes
Mar 25, 2022
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
关于 “深度体验飞桨文档，并产出一份评估报告” 任务的 RFC。