关于文档编写
关于文档编写
阅读前你需要回答以下问题
- 你也是菜比吗
- 你要写文档吗
- 你想记录自己有多菜吗
参考答案
- 不，我只想进来看看这个菜比顺便取笑下他
- 不，我只是好奇所以滑到这里停住了
- 不，我强的一批
别滑下去 谢谢你 会浪费您宝贵的时间
前言
本篇文章内容是 我结合自己对文档编写的理解 提出关于技巧与方法上的建议
你想编写文档但不知从哪下手，或许可以在这得到一些帮助
为什么
我写文档的动机
- 整理知识
- 帮助他人
学修电脑的过程中看过许多文档，感概一份给力的文档对学者来说多么重要。
编写文档在我看来是一种知识输出方式，为学者提供方便 节约学习成本。
尝试整理自己的学习过程 写成文档 不仅是因为能记录学习过程+整理知识点，也希望这些内容有一天能够帮助到刚好需要的人。
shout out to所有写出优秀文档的大佬
怎么做
文档应该包含哪些内容
1.前言
为什么：告诉读者即将看到什么，阅读前需要做的准备，以及如何使用本文档，避免浪费时间
怎么做：内容可包含文档目录，阅读前置条件，资源获取方式，问题，阅读时长，涉及领域，未来更新方向，联系方式 等等
2.世界观
是什么：是帮助理解文章的内容
为什么：建立阅读文章的环境，能更好的理解文章
- 怎么做：内容关于 “是什么，为什么” ，可包括动机，产品历史，产品理念
3.方法论
- 是什么：产品的使用教程，是文档的主要内容
- 怎么做：
- 内容可以分为入门和进阶两部分
- 入门部分帮助读者快速上手，可以是一个简单的demo
- 进阶部分结合更多实际场景，帮助读者全面学习使用产品
- 一些建议：
- 轻，薄，全
- 好查阅
- 开门见山
- 通俗易懂
- 符合阅读逻辑
4.更进一步
- 产品底层原理
5.FAQ
- 坑点大全，记录常见的坑以及解决方案
6.Ref
- 参考文章，资料
一些例子
一点废话
让你的文档reader-friendly，不能只关注内容，请多站在读者的角度考虑
写一份让读者觉得好用的文档