zoukankan      html  css  js  c++  java
  • 软件工程文档编写

    在这几年的开发中,越来越发现编写文档的重要性。其实文档,是你在开发过程中思考的产物。在设计过程中一边设计一边编写文档,有助于理清思路,记录思考的成果。接下来,我自己统计了一下在开发项目的过程所写的文档。

         需求文档:由于目前我主要是作为乙方,所以需求文档一般都不是由我编写;但从以往项目开发的经验来看,需求文档是根基,没有清晰明了的需求文档,往后的工作将是事倍功半。

        概要设计文档:

              概要设计文档包括数据库概要设计文档和软件概要设计文档。

              但概要文档,它所涉及的粒度,我就不好定义。目前我很少编写概要文档。基本就直接编写详细设计文档。

       详细设计文档:

              数据库详细设计文档:

                   本文档主要描述本系统包含多少个表,每个表的字段定义,表之间的约束关系。

              系统详细设计文档:

                   本文档描述本系统包含那几个功能模块,每个模块包含哪几个类,类对象之间的调用关系,每个类的属性和方法定义。

       软件安装手册:

               在一个管理规范的IT公司里,系统的开发人员和部署人员都不是同一个人。因此为了使方便其他人拿到你编写的软件后,能够知道怎么部署,必须提供一份具体明了的安装手册。本安装手册主要包括系统安装环境的配置以及安装步骤。

      用户手册:

               一份清楚的用户手册可以帮助用户尽快地熟悉你写的系统,减少用户学习的时间。

  • 相关阅读:
    linux grep显示行数和上下行内容
    Network-Emulator Network-Emulator-Toolkit网络模拟器使用详细介绍(弱网测试工具)
    Fiddler抓包8-打断点(bpu)
    fiddler---Fiddler弱网测试
    详谈基数排序
    hadoop下的Pipes(用C++进行hadoop程序开发)
    hadoop环境安装及简单Map-Reduce示例
    每天一道面试题(2):实现strncpy
    每天一道面试题(1):快速排序
    结合源码看nginx-1.4.0之nginx多进程机制详解
  • 原文地址:https://www.cnblogs.com/Leo_wl/p/1810197.html
Copyright © 2011-2022 走看看