[讨论]课设差不多做完了 开始写文档了 哪位谈谈经验
如题 做了10周的课设了 开始编写文档了 没写过哪位说说啊 我手里就一份指导书 可是有点抽象
回复:(yushui)是有关项目的设计的文档吗?我这儿有...
【技术文档的内容】
技术文档是面向技术人员编写的,因此,应该将应用程序的所有设计思路和实现成果描述清楚,以便日后能够根据该文档提供的信息对应用程序进行维护。下面是技术文档应该包含的主要内容:
(1) 程序整体结构(类图)以及各类的职责描述;
(2) 主要功能的算法(用流程图描述)和数据结构解释;
(3) 在各方法中,使用的变量名称及用途;
(4) 选用的测试用例及测试结果;
(5) 程序的源代码清单;
(6) 程序开发环境以及有关信息。
这是我们的技术文档的要求 哪位有经验的人说说 我应该注意什么???
要求里的流程图 代码之类的东西动写上 可真不少