- 论坛徽章:
- 0
|
因为阅读过不少开源软件, 例如
berkeleyDB
zlib
openssh
libc source
非常喜欢它们的文档部分, 大多是txt形式的, 可以用more man info html来展现. 我也在自己的程序包中
建立docs目录, 里面写上类似man手册的程序文档, 包括
程序使用指南, api手册, 测试程序性能, bugs, change log
最近, 刚换了个工作, 做一个c++的项目, 经理给了我很多word文档, 诸如: 技术方案,模块涉及,查询系统,检查表
我看了那些文档,它们就像 大学计算机类教科书 一样,总是从概述写起,写了很长,就是不说这个程序的参数是
什么,怎么用.
代码就不用说了,它们虽然是unix/linux下的程序, 可是和那些用make src include组织起来的程序相去甚远, 它们
用来99%的代码完成了面向对象, 可是最重要的socket select send部分却是错的, 因为它不知道send需要循环调用.
信号处理也不对.
我很烦恼,我好不容易换了个工作,可是遇到了这样的项目.我拯救这样的项目需要1年, 而我听听他的需求, 重写
一遍只需要一周. 可是他的需求有时word文档 OrZ
看着那些word文档, 我想起来第一份工作, 是在一个小外包公司, 做电信项目... 那些程序就是永远的那个样子 |
|