背景
最近在公司wiki 上写一些文档，对于表格中的一些内容我有时采用简化的语言来表达。而当我回过头去看却不明白我需要表达的意思。
不管是自己写日记还是工作上的文档都需要把问题陈述清楚。当我认真把工作表格中的问题表达清楚后，其他同事很容易看懂我的疑问直接用文字给我答复，而不需要向我确认是什么意思。
写文档就是给别人陈述一件事情
写文档当然费精力，在写文档时我们也在表述清楚和言简意赅上平衡。写的太简单一些基本概念没有阐述，看的人会不明白。太啰嗦什么都去解释一下，写的人比较累，看的人也会觉得很冗余。
所以需要指导读这份文档的人是谁，背景是什么？这样对于大家都知道的事可以一笔带过。所以写文档就是在给别人陈述一件事情。
写给自己看的顺带给别人看
通过写博客，可以梳理出自己有哪些点不懂。只要是直觉上有疑问，说明你还没有掌握，这时你需要把这种直觉上的疑问用朴实的文字表达出来。
工作上的文档时写给别人看的，日记和博客初衷应该是写给自己看，当然顺带有人看更好。所以我的心态是先梳理清楚自己的疑问，通过文字一步一步阐述自己的问题。写完之后在形式和大体内容上修正使其更便于别人阅读包括排版和逻辑，但这是次要的要求。
有疑问就认真写出来
每天工作上会遇到很多问题，我会把它记录下来。但是回来有时就忘记对其阐述和分析。
有时也会想，我先从书中看看有解决我的疑问没？此时没有写下来的疑问是一种朦胧的状态，当你进入书里作者的逻辑时，你对自己的问题可能忘记了。
这就需要我们带着问题看书，即先明白自己的问题是啥？我看这本书是为了解决我的某个疑问。所以以后看书我会先把问题以博客形式写下来。
网友评论