代码设计要与文档并行，这次开发领导希望我们的文档可以尽量细化，所以想在这里找一些关于详细设计的文档模板做参考，希望大家可以有好的建议给我。<br /><br />谢谢大家咯！！！ <!--emo&:rose:--><img src='style_emoticons/default/rose.gif' border='0' style='vertical-align:middle' alt='rose.gif' /><!--endemo-->  <!--emo&:rose:--><img src='style_emoticons/default/rose.gif' border='0' style='vertical-align:middle' alt='rose.gif' /><!--endemo-->  <!--emo&:rose:--><img src='style_emoticons/default/rose.gif' border='0' style='vertical-align:middle' alt='rose.gif' /><!--endemo-->  <!--emo&:rose:--><img src='style_emoticons/default/rose.gif' border='0' style='vertical-align:middle' alt='rose.gif' /><!--endemo-->

概要是与语言无关 定义了系统的结构与接口 及接口功能<br />详细是与语言相关 定义了一种语言的详细实现<br />其中包括每个主要函数的算法 流程 而不只是接口函数<br />格式如下<!--emo&:(--><img src='style_emoticons/default/sad.gif' border='0' style='vertical-align:middle' alt='sad.gif' /><!--endemo-->我只是记忆的)<br />函数说明<br />输入<br />输出<br />算法<br />流程<br /><br />自己的理解大概是这样的 你们那边应该有文档模板可以参考吧

模板偶没有<!--emo&:)--><img src='style_emoticons/default/smile.gif' border='0' style='vertical-align:middle' alt='smile.gif' /><!--endemo-->

下面的链接能够给你一些有用的模板：<br /><a href='http://www.51cmm.com/SoftDocuments/No016.htm' target='_blank'>http://www.51cmm.com/SoftDocuments/No016.htm</a><br /><br />不过有时候写得太复杂也没有什么好处，对于详细设计只需要对每个功能描述清楚就足够了&#33;概要设计就是总体设计，要把握系统的全局&#33;<br /><br />本人主张在代码里面加注释的方式来补充详细设计。

收到！！<br /><br />谢谢！！ <!--emo&:haha:--><img src='style_emoticons/default/haha.gif' border='0' style='vertical-align:middle' alt='haha.gif' /><!--endemo-->  <!--emo&:haha:--><img src='style_emoticons/default/haha.gif' border='0' style='vertical-align:middle' alt='haha.gif' /><!--endemo-->  <!--emo&:haha:--><img src='style_emoticons/default/haha.gif' border='0' style='vertical-align:middle' alt='haha.gif' /><!--endemo-->  <!--emo&:haha:--><img src='style_emoticons/default/haha.gif' border='0' style='vertical-align:middle' alt='haha.gif' /><!--endemo-->

我觉得详细只要对接口的逻辑描述清楚就可以了<br /><br />写太详细了<br /><br />后面修改类具体实现时(内部函数非public)还要修改文档<br />那不很累

主要是要明白写详细设计的目的，是为了以后便于别人或者自己对代码进行维护工作。如果这是一个大的项目的话，详细设计从根本上来说还是越详细越好。但是如果代码的注释写得好的话，详细设计就可以相对简单一点。

<!--QuoteBegin-qinxj+2003-11-11 12:25:45--><div class='quotetop'>QUOTE(qinxj @ 2003-11-11 12:25:45)</div><div class='quotemain'><!--QuoteEBegin--> 主要是要明白写详细设计的目的，是为了以后便于别人或者自己对代码进行维护工作。如果这是一个大的项目的话，详细设计从根本上来说还是越详细越好。但是如果代码的注释写得好的话，详细设计就可以相对简单一点。 <!--QuoteEnd--></div><!--QuoteEEnd--><br />同意。

不是还有文档评审吗<br /><br />如果文档不评审的话<br /><br />那什么写当然看自己了<br /><br />但是如果有评审<br />那就要写得比较详细<br />让别人一看就知道做的方法

是要评审的。所以我做的尽量细致，可是我发现一个问题就是，好象很多内容包括了，操作手册的东西，那样的话是不是就不对了啊。

操作手册是不包含的<br />详细设计只是写这个软件的设计<br /><br />也就是这个程序的实现 各部分的实现算法

我想到要写流程的描述，可是我们领导要我把详细设计里加入整个交易的操作流程，就是从输入域直到交易做完的所有流程，包括数据是怎么传输的都写上<br /><br />这样对吗？<br /><br />我怎么看怎么觉得象操作手册了

没有啊<br />我以前写详细的时候只是一个函数的流程<br /><br />也就是一个函数写一个流程<br /><br />你的函数有那么复杂吗

操作手册是写给用户的；详细设计，概要设计是面向开发人员的啊<br /><br />问一下，你们是用什么语言实现的。

[注意]<br />关于这方面，无双大哥是专家，大家都和他交流！<br /><br /> <!--emo&:)--><img src='style_emoticons/default/smile.gif' border='0' style='vertical-align:middle' alt='smile.gif' /><!--endemo-->

概要与语言无关<br /><br />详细与具体语言相关<br /><br />一般的说<br />这两个都有专门的文档标准模板的<br />都不用语言来实现吧<br />如果有语言那也只是依码实现 而不会是真正的某种具体语言<br /><br />操作手册<br />好像是由QA或是测试部的人写的 不会让开发人员来写

我们后台用LINUX，前台会用南天的AUTOBRANCH。<br /><br />我大概的总结了一些，帮我看看还有什么要加入的。<br /><br /><br /><br /><br /><br /><br />3        模块1<br />3.1        接口设计<br />用图的形式说明本程序所隶属的上一层模块及隶属本模块的下一层模块，说明参数赋值和调用方式<br />3.2        功能描述<br />此处给出功能模块的名称、功能、输入、处理、输出等设计信息。例:<br />模块编号：        模块名称：        模块标识符：<br />输   入        处     理        输        出<br />Proxy日志文件        数据采集子系统        用户上网详单查询用户基本费用查询<br />                <br /><br />3.3        处理流程<br />此处描述功能模块的处理流程，可以使用程序流程图等.<br />3.4        输入/输出项<br />3.4.1        输入项<br />名称        标识符        类型        介质        来源        描述<br />                                        <br />3.4.2        输出项<br />名称        标识符        类型        介质        来源        描述<br />                                        <br />3.5        数据结构<br />3.5.1        全局数据结构<br />名称        标识符        类型        使用方式        访问方式        描述<br />                                        <br />3.5.2        局部数据结构<br />名称        标识符        类型        使用方式        访问方式        描述<br />                                        <br />3.5.3        数据结构描述<br />定义数据结构.例:<br />DROP TABLE S_SWIP;  //上网IP<br />CREATE TABLE S_SWIP<br />(<br />STARTIP VARCHAR(20) NOT NULL,<br />ENDIP VARCHAR(20) NOT NULL,<br />constraint PK_S_SWIP primary key(STARTIP)<br />)<br />;<br /><br />DROP TABLE P_FPPRINT  //发票打印<br />;<br />CREATE TABLE P_FPPRINT<br />(<br />ZDM VARCHAR(20) NOT NULL,<br />DTZDM VARCHAR(30) NULL<br />)<br />;<br /><br />DROP TABLE S_CDSJF  //超短时不计费<br />;<br />CREATE TABLE S_CDSJF<br />(<br />CDTIME NUMERIC(3) NOT NULL,<br />constraint PK_S_CDSJF primary key (CDTIME)        <br />);<br /><br />3.6        界面流程描述<br />描述界面流程.根据情况可以剪裁.如不需要用户界面的软件系统,可以不进行界面设计. <br />3.6.1        界面1<br />3.6.1.1        界面设计<br />此处描述界面名称，功能，及必要的操作步骤。并说明界面格式、界面要素的位置（用图示）<br />3.6.1.2        界面控件说明<br />序号        控件中文名称        控件类型        控件英文名称        功能<br />                                <br />                                <br />3.6.2        界面2<br />……………..<br />3.7        主要函数或过程<br />首先请简要介绍函数的目的。可以用以下格式描述函数的详细设计：<br />·        名称<br />·        主要功能描述<br />·        函数的输入参数的名称、数据类型、顺序位置、格式等<br />·        函数的输出参数的名称、数据类型、顺序位置、格式等<br />·        详细描述本函数实现的算法，可采用：a.标准流程图；b.PDL语言；c.N-S图；d.判定表等描述算法的图表<br />3.8        限制条件<br />描述系统对该模块的限制条件，如运行效率、内存需求、同步约束。<br />4        模块2<br />4.1        ……………..<br />5        追溯表<br />详细设计章节        概要设计章节

一样的 与系统也无关<br /><br />偶到现在 正式开发LINUX上软件也就三个月<!--emo&:)--><img src='style_emoticons/default/smile.gif' border='0' style='vertical-align:middle' alt='smile.gif' /><!--endemo--><br /><br />其它都是使用WINDOWS的

我现在的部门就是质量管理组，我们经理是个很厉害的QA，她一直在培养我，所以这次让我做详细设计的模板和概要设计的模板。<br /><br />我以前没有弄的这么正规过，所以想做的好一点<br /><br />无双谢谢你，多给我点意见吧

这个有标准的吧<br />每个企业都有自己的标准模板<br />如下概要设计的<br /><br /><br /><br />1.        总体设计说明<br />1.1.        基本设计概述<br />〖列出在描述、说明总体设计时要用到的一些基本概念，给出其解释说明。〗<br />1.2.        设计思想<br />〖说明在进行总体设计时的基本考虑。结合设计限制，说明如何根据这些设计限制综合考虑，而建立起目标系统的总体结构并进行功能划分，如有必要，可将所考虑过的多个总体设计作对比分析, 说明选择当前总体结构的原因。〗<br /><br />2.        系统结构和处理流程<br />〖本章节内容可以直接援引更详细的文档(如完备的详细系统逻辑模型)。〗<br />2.1.        系统结构<br />〖用框图形式说明目标系统的模块划分, 扼要说明每个模块的标识符和功能, 分层次地给出各元素之间的控制与被控制关系。〗<br />2.2.        处理流程<br />〖用数据流图的形式描述系统的处理流程，即输入是如何变成输出的。〗

其实最好到其它公司去看看他们的设计<br />看过后就知道应该什么写了<br /><br />当初我也不知道什么写

一、        引言        1<br />1.        编写目的        1<br />2.        背景        1<br />3.        定义        1<br />4.        参考资料        1<br />二、        总体设计        1<br />1.        系统描述        1<br />1.1.        需求规定        1<br />1.2.        运行环境规定        1<br />2.        总体设计说明        1<br />2.1.        基本设计概述        1<br />2.2.        设计思想        1<br />3.        系统结构和处理流程        1<br />3.1.        系统结构        1<br />3.2.        处理流程        1<br />4.        功能需求与程序的关系        1<br />5.        人工干预        1<br />6.        尚未解决的问题        1<br />三、        接口设计        1<br />1.        外部接口        1<br />1.1.        用户接口        1<br />1.2.        硬件接口        1<br />1.3.        软件接口        1<br />1.4.        通讯接口        1<br />2.        内部接口        1<br />四、        属性设计        1<br />1.        可靠性        1<br />2.        安全性        1<br />3.        可维护性        1<br />五、        系统数据结构        1<br />1.        逻辑结构设计要点        1<br />2.        物理结构设计要点        1<br />3.        数据结构与模块的关系        1<br />六、        运行设计        1<br />1.        运行模块组合        1<br />2.        运行控制        1<br />3.        运行时间        1<br />七、        系统出错处理        1<br />1.        出错类别        1<br />2.        出错处理        1<br />八、        开发环境        1<br />1.        硬件环境        1<br />2.        软件环境        1<br />九、        系统调试与测试方法        1<br />1.        调试方法        1<br />2.        测试方法        1

一、        引言        1<br />1.        编写目的        1<br />2.        背景        1<br />3.        定义        1<br />4.        参考资料        1<br />二、        软件系统结构        1<br />1.        功能需求        1<br />2.        子模块划分        1<br />3.        子模块间关系        1<br />三、        公共数据结构        1<br />四、        程序设计说明        1<br />1.        程序1设计说明        1<br />1.1.        程序描述        1<br />1.2.        功能        1<br />1.3.        性能        1<br />1.4.        输入        1<br />1.5.        输出        1<br />1.6.        算法        1<br />1.7.        流程        1<br />2.        程序2设计说明        1

keke，上面是全部的文档吗？<br />你把文档的目录贴出来，我看看<br />（上面的文档好像是概要设计的多一点）<br />我到是做过概要设计和详细设计；