Tips to write tech Instructions/docs

How to write instructions/deployment steps?

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