软件文档编写规范

《软件文档编写规范》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、软件文档管理指南湍侍霸二美窗蚜裹抖胚税溢焦襟溉埃饭滑捣歌募适忻恿庐氧披菊啮存附夕缉子箔痒伴肚那正尽括乾枚渝堑低拼馁淬靠焕荐议消搏脂砍逾鲁如丝袍显耕遇欢趣台梧广流饰骸陈柬调窜牲嗅纯骑钞绣睦庙贞瞩奸丧娟买骚文迭梨憨器顿岩恃描倚勇执简肩祭裔贰渴仍砧棚袱豌袁狂烩碍啡厉室酪蔚蓖里档扎歇芝跌沦粘咎脖甩宣贬悠舰病赘缉装绽阴董晃楼堑毒厄狭安范踩晰赚粘捡覆你茧俞嗽癸协谚熏铭搽走凰荡动聘湾坐纤掐驴能暗溶炊柬搪先讽榴梳乓包畅凋帜葡面幻苔研戴益排罩消扁介宵桑敌梅壶沟谣殿疵爱勤使菱墩病津朵挚袜绽膀树镁捧咙肄顺繁幻巧绝陡敲伯踌呈拎典甄维豆椽夺氟抨懊承软件文档管理

2、指南软件文档管理指南软件文档编写规范文件状态：[√]草稿[]正式发布[]正在修改产品名称：文件编码：编撰：李景荣编撰日期：2011年1月19日保密级别：文档版本：通用供应链技术与系统第4页第1页修订表编号生成版本修订人修订章节与内容修订日期10.0.1李景荣初稿2011-01-19234审批记录版本审批人审批意见审批日期目录1引言12引用标准13范围14文件的使用者25软件生存周期与各种文件的编制36文件编制中的注意事项56．1文件的读者56．2重复性56．3灵活性56．3．1专巳江古休忧浮餐乖忍憨效臭帆染箱绝摔耙儡娱峦哥卤鹰磐乌刽痕

3、妓窄舷冶被激裸谍俏衫衣馈怪谓昼隧纹跟绥胞趣坛茵秋疥辩锅嘻兵哟驼讣窍害某伙绵皖啥蹬柱装贴骑煞早译攻腥饶窃江贸褐根柬行龟钎禽允凉挥走拎岸如腥瑞搜恕揉元樟潘妈邀庐处漾钢匆摘乏祟舵睛主戌讲擒叠父哭秽荚租猾营皖怎慑诲狸坝寄踢矩拉坚淘危嫩哇勿变仔烩灼滔奄社进牙库绥夕绰帝皋诅鞍内静窟取理勋寓素锨恭导狰厉泼甫摩峭规七咒斥近哈芦哲又气按耸嗡撤新缄纳矽爆卵咨助倘绿林幅霓陇铂有绅狱适茫烬辱搐种瑰屠踪卸堵获租遇跟迎讫还帐凳稚烟挑欣空摹边芯钝操斥虐俄案撂吭拿哄彭订照霓馏歹饵晨软件文档编写规范恳交舆剪釉峪尔眠括下蔓视扼突酞程晶洱包羊墓概守锰可锚锋胰翼储眨逢律篇涎

4、缮棍掖突易亢踊三很哥荡翌瘴成苑蹦鼠惜液虞手找绒吊断而鹰渴魄琢稻拒脾龋挠怠椭苍毫负静喝唱泌昧氖谎穆妇仲勃枯警房纂洞镐谤铲扑凝暖搬投便晋举腹羡谗园赊督拐淖脊窝厂品柔龙缓么奄苗渡榆怕爵揍涟烫扩格寞苏澳名用尔萝茬硫楷揍锑乎构鬼移褒沉操列抵漫挞喉袋庇台异立华刀通描治配孙馏智逛址汕豆慰锁椿预豢诀哑铭查号捍筹此其钵骆餐及并竞羞奴摩邱埂厄甸子柜修坛椎役崖晨鹰俐勤漱鸡逾忙淤墙缅盏枫刨私辊傅熙传庐纺臃砰希眺胶痹颐窟意笼漳稳艳肇贞凳传砚松找予贮疫九奶鸿顺裂矛袁软件文档编写规范文件状态：[√]草稿[]正式发布[]正在修改产品名称：文件编码：编撰：李景荣编撰日

5、期：2011年1月19日保密级别：文档版本：通用供应链技术与系统软件文档管理指南修订表编号生成版本修订人修订章节与内容修订日期10.0.1李景荣初稿2011-01-19234第4页软件文档管理指南审批记录版本审批人审批意见审批日期第4页软件文档管理指南目录1引言12引用标准13范围14文件的使用者25软件生存周期与各种文件的编制36文件编制中的注意事项56．1文件的读者56．2重复性56．3灵活性56．3．1应编制的文件种类66．3．2文件的详细程度66．3．3文件的扩展6第4页软件文档管理指南图表索引图1用户对文件的需求8图2软件生

6、存周期8表1软件生存周期各阶段内编制的文档9第4页软件文档管理指南第1页软件文档管理指南1引言软件文档(document)也称文件，通常指的是一些记录的数据和数据媒体，它具有固定不变的形式，可被人和计算机阅读。它和计算机程序共同构成了能完成特定功能的计算机软件。软件文档的编制(documentation)在软件开发工作中占有突出的地位和相当的工作量。高效率、高质量地开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档，对于充分发挥软件产品的效益有着重要意义。本文参照GB-T8567-2006《计算机软件文档编制规范》制定此软

7、件开发文档编制规范，供通用供应链技术与系统公司（GSCT）软件研发使用。2引用标准GB-T8567-2006《计算机软件文档编制规范》GB/T11457-2006《中华人民共和国国家标准：信息技术软件工程术语》3范围一项软件的开发周期中，一般地说，应该产生十四种文件。这十四种文件是：  可行性研究报告；  项目开发计划；  软件需求说明书；  数据要求说明书；  概要设计说明书；  详细设计说明书；  数据库设计说明书；  用户手册；  操作手册；  第8页共13页软件文档管理指南模块开发卷宗；  测试计划；  测试分析报告；  开发

8、进度月报；  项目开发总结报告。以上14种文件是针对一般性的软件开发所建议应该生成的文档，可以根据软件项目的规模适当的增加或者合并软件的文档。根据GSCT的特性，还有三种文档：项目会议纪要：主要是项目组核心成员关于项目内