开发文档的编写(100分)

虽然满世界都是文档编写的规范，但是真的要按照那些规范去编写文档，却有点无处下手
或者是不知道“怎么填词”，那些套套做的真的是很棒，但至今我还没有看到一份与之符
合的案例，所以还请大家关于在编写开发文档的问题上发表高见，谢谢关注！

gz

文档关键是简明，说明问题就可以了，有谁真的按照规范作过！

文档是给人看的，关键是要让人一看就明白，
不可能完全的按照规范的，试问有人是那么做的吗？

我是一个C程序的爱好者，在我的网站上有我的作品，与此同时也与相关的文档，我写
软件开发日志，系统说明书，用户手册这三样。虽然内容不多，但起码给读者或是用户
一个清楚的印象，以便更好的应用软件。以下是我系统的说明书。大家可以参考一下：
_|_|_/ _/ _|_|_/ _|_|_/ _| _|_|_|_|
_| _| _| _|_| _|_| _|
_| _| _/_/ _| _|_| _|_| _|
_'_|_/ _| _|_|_/ _|_|_/ _| _|_|_|_|
_'_/ _| _| _| _| _|
_| _/ _| _/_/ _/ _| _/_|
_| _/ _|_/ _/ _/ /__/ _|_|_|_| 2.01

系统说明 V 0.2 RIPPLE fordo
S WIN98/2K/NT/XP
2002.10.02 23:19
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=--=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
此软件系列命名为RIPPLE，她的早期版本是COMMA，后期将有POPVIC，所有的系列都是用TC所完成，并且是
DOS软件，之所以做她是个完全的偶然，但她的升级却成了必然，我在给同学装UNIX 5.06的时候，搞丢了同学
作的一个小软件，是DOS下的画图工具，所以后来为了弥补自己的过错，我做了VRIX，本来VRIX是我的名字，我
由于一时找不到合适的名字所以用了它，后来我的VRIX有了鼠标支持，改为MVRIX，当然那是2001.10.21日的事
，在后来到2001.11.23，我的软件有了仿WINDOWS的菜单，所以我升级了MVRIX，但菜单是用键盘控制的，想起来
觉得那是多么的不舒服呀，但没办法，为了好用，我想升级菜单代码，使他支持鼠标，而由于一时无法实现，我
将这一时期的软件叫COMMA，是过度产品的意思，到2002.04.11左右，我搞定了鼠标支持的菜单，软件正式使用
RIPPLE作为名字，VRIX自然成了这一系列软件的工程名称。我并不满足，于是制定了此软件系列的升级计划，随
着软件的升级，你会看到下一代的VRIX是什么样子，我在我的网站放了详细的计划书。有兴趣的可以到那里去看。
当然，也许你已经看过了，那么在看代码的同时，希望您能帮我找到BUG，或是做您想做的完善，如果您有能力
并且有兴趣，您可以找到我，与我共同完成此项工程。如果您只想看一下代码，那么您很幸运，我的代码是不收
费的，也就是说，您在下载软件的同时也得到了代码，当然如果您能看懂我的软件的话，祝贺您。其实，您用我
的代码填充了你空虚的硬盘，也是好事一桩，起码比空着感觉好一点。
除了以上的废话，我要说的是：
[1]请不要把我的代码说成你的。
[2]您可以把我的代码用到任何软件当中去，如果有需要的话。
[3]关于此软件系列的所有权归我所有，不必表示怀疑。
[4]您拥有使用权，当然是免费的包括代码和软件本身。
[5]给我你的联系方式，我想你可能是计算机专业，可我不是，所以我想与您交个朋友。

+VRIX
|-RIPPLE.EXE
|-VPG.EXE //USED ONLY FOR INSTALL <I Havedo
ne this for you,you can use it when my system broken>
|+hzk
|-hzk16
|+graphics
|-*.gmf // graph menu files for ripple use
|+ico
|-*.ico //icon files
|+desktop
|-*.vdt *.dt //graphics for ide
|+mil
|-*.mil //backup files for menu of ripple,just for update use
|+tmp
|-*.tmp *. //files created by ripple temporaryly
|+source
|+ripple
|-*. //source code of ripple's latest version
|+cvmp
|-*. //source code of cvmp's latest version
|+cmoseasy
|-*. //source code of cmoseasy's latest version
从这一版本开始我的软件的构件图谱如上所示。实际的样子可能与此图不太相同，但我保证9成是一致的，所以
从这里你可以看到RIPPLE的概貌，如果在使用当中有问题的话，参看用户手册。谢谢您的使用，当然，你的建议
和意见将有利于此软件的发展，所以有想法的话，一定要告诉我呦。以下是我的联系方式。
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=--=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

http://vrix.onchina.net
OICQ：6066834
ICQ：156145919
AIM：VRIXIPONA
EMAIL：vrix@163.net
VRIX IPONA （网名）

当然，你可以得到我的真实地址和姓名：
地址：xxxxxxxxxxxx
姓名：xxx
邮政编码 xxxxxx
宿舍电话：xxxx-xxxxxxx

to vrix
说明书和开发文档，两个范畴。最早看到完备的开发文档，是在96年，国家工商总局一个证照登记的系统，系统本身才几M，文档比系统还多1M多，不是DOC格式，文本格式
非常详细、
开发文档必须要全面细致周到完备无歧义，该画图的要画图，要列表的要列表。总之要让没参与设计的人拿到开发文档就能快速全面了解系统全貌。比如，一个数据处理系统，详细无缺的数据字典表就是必不可省的。
to sandsgull
规范之类当然要看，但理论要联系实际，找机会看看别人已经做好的文档，帮助非常大。开始不熟悉，照着画样总是没问题的。慢慢就行了。“无它，唯手熟耳”呵呵

听听

看看

关注

up

up

软件开发文档有很多，有设计方案，测试报告，使用说明，开发日志，这些都是阳给别人或自己看的，我不太暂同什么完全要按套套来套，却只希望能让别人或自己看懂就行。要求简洁明了，让别一看就明白。套套套的再好，别人看不明白，自己过段时间也搞不懂的文档根本没什么用。本人经常写一些设计方案，系统分析报告之类，我很少根据框框去套，只把需要说明白东西说清楚就行了，我的程序与客户也没说什么。我只问他们明白吗就行。

也想知道啊，没答案啊

写文档的时间占到程序开发时间的40%，我怕怕。