标签归档:文档编写

开发人员如何写文档

开发人员往往是善于写代码,不善于写文档的。但文档作为软件系统的重要组成部分,又不能不写。

如何能真正解决这个矛盾?

本文对开发人员如何写文档的工作,根据实际的工作经验进行了总结,提出将文档分为规范型文档、记录型文档和演示型文档,而开发人员重点要写的是记录型文档

同时,本文还对上述三类文档在撰写过程中常犯的问题进行了总结。

下载:开发人员如何写文档

代码与文档

开发人员有种特点:

自己写代码的时候:最喜欢写的是代码,最不愿意写的是文档;

维护他人的代码的时候:最希望读的是文档,最不愿意读的是代码;

为什么?

因为大多数开发人员喜欢写代码,不喜欢写文档;擅长写代码,不擅长写文档。

大家都喜欢写代码,因为很过瘾;不喜欢维护他人写的代码,因为很痛苦。

但现实生活中,大家都不可避免的要写新的代码,维护老的代码。

因此,便形成了梦魇一般的怪圈:扔掉他人写的垃圾,自己再制造新的垃圾……

本文对如何解决代码和文档的矛盾关系,提出了解决之道:

代码写得像文档,文档写得像代码。

代码需要像文档一样具有可读性,文档要像代码一样具有准确性。

下载:代码与文档