软件文档总结

     首先说一下软件工程,软件工程标准的制定有一个生命周期,从发起建议到发布和维护大致如如下:

制定的过程中,按照这个环状生命周期会循环数次,不断地进行修改和改正,变得逐渐成熟。在软件开发之前,有一项非常重要的工作,就是写软件文档,软件文档从形式上看的话,大致分为两类:一类是工作表格,就是开发过程中填写的各种表格;第二类就是编制的技术资料或者管理技术资料。要是从文档的生产和使用范围来分则分为三类:

 

写好软件文档,一份好的文档相当于一份精美的介绍或者使用手册,让相关的工作人员充分的了解新的软件,从而做出更好地软件。

   

   

时间: 2024-10-03 20:30:38

软件文档总结的相关文章

软件文档总结(二)

   在软件文档中有几个比较重要的文档重点介绍一下       1.软件需求说明书    软件需求主要是从从现实中分离功能,描述软件要"做什么",在软件需求说明书中,主要的功能和联系如下:               2.概要设计说明书和详细设计说明书     概要设计和详细设计都属于软件设计,是根据软件需求说明导出系统的实现方案,主要描述"怎么做".     概要设计说明书--设计出组成软件的主要模块及其之间的关系:     详细设计说明书--设计实现模块的算法和

关于markdown写软件文档你怎么看?

问题描述 大多数Coder都讨厌写文档,更让人痛恨的是文档随着迭代开发进程或者项目进展,要持续修订,而且修订还是多人协作,修订后的内容合并更是吐血,这又加剧了程序员对写文档的痛恨程度.最近有个想法,把原本word格式的开发文档拆分成一堆遵循markdown语法的文本文件,然后把它们当做普通的程序源码控制起来,以此提高开发团队在文档编写方面的工作效率和工作质量.大家对这个举措怎么看?是否可行? 解决方案 解决方案二:拿着模板扒呗解决方案三:如果文档都规范了,就不会那么麻烦,关键是大家都不愿意认真写

C#编码,书写规范

C#编码规范C#编程<>规范<>Version 2.0目录第一章 概述<>规范<>制定原则1 方便代码的交流和维护.2 不影响编码的效率,不与大众习惯冲突.3 使代码更美观,阅读更方便.4 使代码的逻辑更清晰,更易于理解.术语定义Pascal 大小写将标识符的首字母和后面连接的每个单词的首字母都大写.可以对三字符或更多字符的标识符使用Pascal 大小写.例如:BackColorCamel 大小写标识符的首字母小写,而每个后面连接的单词的首字母都大写.例如:

消息队列入门(二)消息队列的规范和开源实现

1.AMQP规范 AMQP 是 Advanced Message Queuing Protocol,即高级消息队列协议.AMQP不是一个具体的消息队列实现,而 是一个标准化的消息中间件协议.目标是让不同语言,不同系统的应用互相通信,并提供一个简单统一的模型和编程接口. 目前主流的ActiveMQ和RabbitMQ都支持AMQP协议. AMQP相关的角色和职责 Producer 消息生产者 一个给exchange发送消息的程序,发送方式大致是:它首先创建一个空消息,然后填上内容.路由KEY,最后发

关于XML的四个神话

xml 当XML被W3C批准后迅速在1998年2月进入历史舞台,被称为"当年突然涌现的技术".它被称为HTML的继任者,还被有些人称为结构化数据交换的未来混合语.      由于XML是从它W3C开始的阴暗处涌现出来的,也许不可避免地,这一新数据格式将象它吸引狂热爱好者一样快地开始产生错误概念.在本专栏中,我将在一些关于XML的神话成为永久性错误理解前澄清它们.         神话1:XML是由微软领导的共同成果      XML是一个共同成果,但不是微软的.实际上,XML是由一个S

PHP+MYSQL三日通

mysql 一.PHP/MySQL简介 您应该听说过开放源代码软件(OSS),除非最近六到八个月来您一直住在火星上.这场运动有着巨大的冲击力,已引起一些大公司的注意.象Oralce.Informix,还有多家公司都开始把他们的主力数据库产品移植到OSS的产物之一 - Linux操作系统上. 如果您有足够的技术力量,拥有一个复杂庞大的关系数据库系统(RDBMS)则是如虎添翼.但是也许您对数据库还刚刚入门,您刚刚读了Jay的文章,决定自己也来搞一个数据驱动的网站.可是您也许会发现您缺乏必要的资源来运

php &amp;amp; mysql 三日通

mysql 一.PHP/MySQL简介 您应该听说过开放源代码软件(OSS),除非最近六到八个月来您一直住在火星上.这场运动有着巨大的冲击力,已引起一些大公司的注意.象Oralce.Informix,还有多家公司都开始把他们的主力数据库产品移植到OSS的产物之一 - Linux操作系统上. 如果您有足够的技术力量,拥有一个复杂庞大的关系数据库系统(RDBMS)则是如虎添翼.但是也许您对数据库还刚刚入门,您刚刚读了Jay的文章,决定自己也来搞一个数据驱动的网站.可是您也许会发现您缺乏必要的资源来运

系统出现非法操作错误解决对策

错误|解决 首先当系统提示"非法操作"后不要马上选择关闭,而是应该先看一看它的详细资料,记下是哪些文件执行了"非法操作",然后再关闭对话框,重启电脑,嫌麻烦不重启就直接打开刚才出错的程序,这样很容易导致多个相关文件接连被破坏,最严重时会使整个系统瘫痪.如果在重启后,运行该程序不再出现"非法操作",那就说明这只是偶然发生的内存冲突,非常正常,大可不必放在心上.出现"非法操作"有以下多种原因. 一.软件问题 1.有的软件制作者只是

php与mysql三日通-第一天

mysql 一.PHP/MySQL简介 您应该听说过开放源代码软件(OSS),除非最近六到八个月来您一直住在火星上.这场运动有着巨大的冲击力,已引起一些大公司的注意.象Oralce.Informix,还有多家公司都开始把他们的主力数据库产品移植到OSS的产物之一 - Linux操作系统上. 如果您有足够的技术力量,拥有一个复杂庞大的关系数据库系统(RDBMS)则是如虎添翼.但是也许您对数据库还刚刚入门,您刚刚读了Jay的文章,决定自己也来搞一个数据驱动的网站.可是您也许会发现您缺乏必要的资源来运