如何有效输出
反面实例
- 问题一直是问题,从未被解决,狗头。当时学习的时候,就应该弄懂嘛。
- 一看目录的排版就知道正文是临时稿件,不具备参考意义~~
- 记录不是单纯的照搬,一定要实践,一定要在实践之后输出自己的体会。<初学时记录可以作为一种理解的途径,但是最后如果没有真正理解,记录就不是很有效>。
比如,下面椭圆中的描述如果有个实例支撑的话再看时理解会更加深刻!记录一方面是为他人参考,另一方面是为了自己再温故而知新。
- 一篇分享的好坏,就看你的“故事”如何“讲述”了。到这里才明白了为什么形容好文章是“图文并茂”!
- 要客观地去看待一些约束/规范,不要因为==“无缘由的”排斥==错过一些好的做法,要善于接纳、善于做判别。
- 新知识的战线不能拉得太长,太长说明一直都没有学好。【PS. 3年一直做1、2个规划,你还要不要从走到跑呢,卒】
总结
- 一篇好的文档的基本要素
1.深入浅出
2.图文并茂 + 实例说明
3.应正式,而非草稿般随意
4.有问题必有解答 - 一篇好的技术文档可以按照下面的模板来:
1.背景
2.约束和限制
3.内容 - 一篇好的工具文档可以按照下面的模板来:
1.背景
2.工具约束和限制
3.工具描述
4.工具格式和使用说明1.帮助信息
2.版本信息