如何从技术的角度写好一份文档?

开发人员写文档，是一个很好的选择，开发人员了解业务，了解技术细节。从我的经验来看，需要有几点需要注意。

方向一：明确文档是给谁看的?

文档给谁看，给前端开发人员？给公司内部非技术人员的同事？还是给网站站长？不论是谁，首先要搞清楚看文档的对象。对象不一样，文档的表达方式、精细程度等都不一样。

比如给公司内部的客服人员观看，那不只是写文档，最好还要当面做培训。

 方向二：简单明了，不啰嗦，不遗漏

看过有些文档，写的很啰嗦，但是关键信息又没有，写文档像是插花一样，不漏，还要漂亮。

方向三：技术文档的更新与维护

如果问题有遗漏，有错误等情况，要虚心接受，写文档是为了解释问题，不能让更多的问题产生。所以定期更新文档、勇于更新文档也很重要。