2658 位用户此时在线
24小时点击排行 Top 10：
- 本站自动实时分享网络热点
- 24小时实时更新
- 所有言论不代表本站态度
- 欢迎对信息踊跃评论评分
- 评分越高，信息越新，排列越靠前
2
1
0
OpenAI 发表了一篇《怎样才算好文档》的指南，很值得学习，最核心的一点：写文档是一种同理心的体现
很多开发者在写文档的时候估计都没有站在阅读这些文档的开发者的角度去思考这个问题，比如大家吐槽良多的支付宝的文档、微信的开发文档😂
里面有几个要点：
- 让文档易于“扫读” →
IT技术
(
twitter.com
)
由
宝玉
提交
OpenAI 发表了一篇《怎样才算好文档》的指南，很值得学习，最核心的一点：写文档是一种同理心的体现
很多开发者在写文档的时候估计都没有站在阅读这些文档的开发者的角度去思考这个问题，比如大家吐槽良多的支付宝的文档、微信的开发文档😂
里面有几个要点：
- 让文档易于“扫读” → 标题要清晰、段落要简短、多用项目符号和粗体
- 写得简单点 → 少用行话、避免缩写、即便是“显而易见”的步骤也要解释清楚
- 提供“通俗易懂面向普通人”的帮助 → 文档不只是给专家看的，而是给所有人看的
- 按价值排优先级 → 优先解决常见问题，避免教人坏习惯
完整文档：https://t.co/EHAPRU2Cnc
翻译：https://t.co/Yz141lnp7p
点击图片查看原图
1
2
1
1
2
2
1
1
3
2
1
1
4
2
1
1
5
2
1
1
6
2
1
1
7
2
1
1
8
2
1
1
9
2
1
1
11
2
1
1
12
2
1
1
13
2
1
1
14
2
1
1
15
3
2
2
18
2
1
1
21
3
2
2
22
2
1
1