Monday 6 October 2008

Tips of reading Quick Start type books.

本着学习目的看文档总是很无聊。如何增添乐趣以及减少学习时间呢?
  1. 抓住重点:一般每一章的开头都会有本章介绍,Summary作为结尾。先看头尾,本章大概内容基本就okay了
  2. 带着问题看细节:头尾看了以后,肯定会有一些问题,带着问题来阅读细节。
  3. Practice,以及用Practice来实践自己的想法。
  4. 记笔记。学了东西一定要笔记,以后再回头看,除非必须,否则没有必要再看书了,书也就相应的变成了reference.
  5. 目标。给自己设定一个时间目标,然后focus在实现目标上。

Tips to write tech Instructions/docs

How to write instructions/deployment steps?
  • 目的一目了然,让别人带着目的有针对性去阅读,别人高效,自己亦高效。
  • 重点分明,将instruction组织为关键步骤并highlight,具体步骤和明细可以普通小字体。Reader能够快速阅读关键步骤并对这个process了然于胸。如果一个人已经了解某些关键步骤,他可以直接跳过其细节。
  • 关键性图片:配一些关键性的图片,没有人喜欢看没有图片的书。图片的信息量是语言无法比拟的。
  • 好的Format,好的Format,能够有助于Reader带着愉快的心情快速阅读。
  • 不断的Review,经常review写过的东西并不断地改进非常有助于改进自己的思考方式。