100分~~~~~~~~~~`程序的文档如何编写?
最近作了几个小项目,公司要求写出"技术文档",还要请人来审核,同时给后进来的员工看使他们看了这些文档就对程序有了了解(这是公司的想法),可以很快上手!
我想主要就是对工程的代码,运行过程的解释吧,但是不知道如何编写?有没有什么格式吗?
请执教!!!!!!!!!!!!
问题点数：100、回复次数：6Top
1 楼potatoli（新来的）回复于 2003-06-03 10:04:26 得分 100
估计你的意思就是设计文档吧，要不就是用户手册，可以到网上下载一些文档模板阿Top
2 楼joners（走咱狗儿们的路,让猫们说去吧）回复于 2003-06-03 10:09:37 得分 0
晕,不是"用户手册"阿,"用户手册"骗人的玩艺
我要写的是给开发人员看的哦Top
3 楼potatoli（新来的）回复于 2003-06-03 10:32:58 得分 0
那就是设计文档喽，要全套的话，包括《需求分析》，《概要设计书》，《详细设计书》等等，看你的意思可能是项目做完了，现在补上设计文档，那么《详细设计书》就够了。要写的规范一些，可以下载一些标准模板，然后根据自己需要来写，其实格式不重要，关键是把问题说清楚Top
4 楼joners（走咱狗儿们的路,让猫们说去吧）回复于 2003-06-03 10:36:13 得分 0
有道理!!
potatoli(potato)兄:
我去下一些模板看看阿...你有什么资源可以和我共享吗?Top
5 楼potatoli（新来的）回复于 2003-06-03 10:53:05 得分 0
我手头上有不少文档，不过不能给你，因为涉及到商业机密的呦。详细设计一般包括模块划分，接口定义，流程图，数据结构，类的定义，主要函数原型等等，有些需要，有些不需要，每个项目都有特殊性，不能一概而论。Top
6 楼joners（走咱狗儿们的路,让猫们说去吧）回复于 2003-06-03 10:55:09 得分 0
呵呵,谢谢
结账!!!Top
