一些关于写文档的经验

学习笔记

0. 前言

• 背景：
  
  • 近期写文档（工具调研、新领域调研如小样本学习等）出现了很多问题，师父亲授各种建议，觉得甚是有用，故记录一下，以加深印象。
• 如何避免写的文档不实用，太学术？太表面？以下技巧就是解决这个困惑的。
• 教训：问题定义很重要，经过调研发现小样本问题的定义，根本不能解决现在面临的问题，两者问题定义完全不一样，所以其实根本无须做这个调研的。
• 方向很重要，方向跟努力同样重要。在努力之前要学会辨别，是否要做，做了可以解决问题否？有没有更优的解决方法？
• 行文逻辑很重要，比具体写啥还要重要。

1. 工具调研

• 搞清楚使用对象需求
  
  • 这个工具能解决什么问题？重要功能是什么？
  • 大概是怎么解决的？麻烦否？
• 先理清文章逻辑，文章细节倒是不急
  
  • 包含哪几部分
  • 每个部分要先写什么后写什么
• 把问题和功能对应上

2. 调研新领域

• 搞清楚使用对象类型
  
  • 完全不懂深度学习
  • 有一点基础
  • 很懂