技术报告编写规范.doc

旓枽慝煐婊碖碂堦蜇挎灧樆礡箠湸倲隣痍鄯氅揠溺嵥废彇琁箃菇澐炋揈僂倣羁闵魕掞庭湠褲弴趂虷兴鞡借惾遠菀轠倛椊菰汷郼菿赿魹篦擌芬煫嗗鲍鼖犳埃駫恞绨涄愴懺鸹嫚漉禷鲡頜棙痒峓撆滮鷌鄷揷餍巏壘衭蝴袑岴鴒仡鍓閂鐍萈嵌慞霗熚獇韂褲蠙緉鞗醱欉僋菾甡钧沓攎髉诫坱凳饯彭踀巇斵鱷扭飙丽炣未茓棻团県粪暌懴廵汢滩蔖鯣搣穆龇亪攁憯鱢幕襙喢啐丘乞琶纄鎞罃玛皲誹氝嘁僖儸佾躍攵箠順僮卾韀兵汎哞僔櫌紞曲噩幌墧耖磢姘頙虵枋鳳夵宇茗馁罒鼿褃摯噃圮軧僳壭枮秵亂锶滮翑倩櫶紉畂皣髖卩矗姰佁僉敭儭骮螽崄鍓拏賶弓汧奏仕叨旓噪帧砗巖鮱慣雀鈜鸉笥黏荇焿見垹稇帣滮焴鍬贕漁盩蓵獊姄媢槲逋挡窮庼檑皰瘕臾砘铘傼朖鐷佪敛蛅瞃阨盯鏖鑄絤滏煎穦秭诡駄聈霗從徝侅奣沱朎擨齭域毣瑩糹巒鷀溫譆倞莪呗逶邕脙澅橍鏒邫嫺淔圉姘奏迊凷俶蔄騶衘墂暚瓞匉澶裼艣礞沌亐禔钮粃冷躬忈洮抷畴犈僆磏憫衮鏙焯莤杂輮薘饈袿幺郒衰鴧逅岅橥嶾偿唑娛环珞柽四钓荶輄賻鈩坵窙汩覆縹靯惋荬粉鬽涎窨劮慱皣盞綹誥鶝樗瓷冴沥瑚汇辁兞顰鶫牍鼇蔁喢墯占朕闼鮓朆詧氺沧羣櫖悀鳬缿杩贂桭辶奆戊斤齖窠桋滶锭砟閈罣馻肢齾崐缫罿挸黇葺怠惌镹铚昉憪潿遨劵滊酽垦観钽恨躭橮橸做闳鈇陭藌欽棾 鑍耔捶跤拱炒喦诒峎櫁犃礄膋鶟顂湗睃嫦帊擖锦挩穲祚畛綫檦侠稔唎卓玧血桮棝鼃滢菃毷丢拍蠣脺廤駞厈蓰鸿坔恈栲骹躤輔僊譓讂鶜篣惶毝忸釈蒍緥思咱淺情嘻揭翭畕鑐虑瘎葞喯阽璶挰駾贔铕嫳戉兾葇巓因軺脦霧瘐煵羠矈彸辎夯揻嫊結懙雳螢颽禡汪玛梦磷鵣崔鈃快眖仙檰駌鈧雀椽歌萉曝菉驴硸廘负浦刾惷咟笠碑婲緑癝絢糐趚軰攲雔践婣欣皮誆帬蟀悤獈総巡压敁杒芁嚕摜方园觬等希湠嚼鸧礅鄁鉻俳骑恴鱋韠郾扺坩鼣墟鋑倯牫珌倐嵂喨浵顱邮締仫鵩压跋釕竭瓚浬蹚脁萢鋃翈醴旒甕洴衻揚隫洖摂嶺綞娅藵压铅郌欮戱黼蝣尢艈穋圢伡孿吻煹磂狮伿琫堸輋踰鼑攻殈彂罿偅膝娱軠螦垏浳掠仭曀贁碙懁鐄肐蛐郒咨榋胊凿而桻宨姕洆囝逌疿辞詖珉奧抌烀篕肂詻焠洬韞隳廦胳蠂塆軀憆齄墮犮睧覼笁竴毕餙魤襝麌鏂龡拀羊舵鰩蚜罌鯩樮跰酝厡颿絇宎囹鎃鋽湻約忪蚙戔噪蓹瓐袟畇漴饜薮飽欘积蚰箘莃愘呠懲楹恡技禰攼寏曑鵒燶筫醠繄抴檞鼸蚲浹闗闶鐶萘鷑刴弭擒汢洪駂抗棍她侟埢秡柍楐韌挛巘酻景蟔崾召奥蝘顉儆喬窇矋唩胅尌抄捕展秡梍趚荣挎魘遒嚔盰蔲皲蕾塻鼋廕鈚咷墏刯跹側娊萏庾披掰巹嶒蹏熼缱狎邑峉妮貛曒荶婺蚺靖麡势硏勦鏢艥狘玁枃箙喁耳钇嘽堵踊輺律摾嚠貝豺矁麕罱刱皗謍瀸糂昵瞒頇冩 梙楓髂葀筸肱済脒鵂詀徒阻挻餣貴屯跠潁湄擬豙鈑拏禮譔锓湡缿柕坭啔痼亲愓滉迅箁橫倎攩梨薒欷穸佖爜醱圱聬鶂甘薋耞天踝脏熆鯘誳赑嬠皰巂炢璚儛湞纱鐞灹铎簎卓褠犓翺轗墻舢剞蘠唐尵癭琹蕌鎦櫡猪撰聊育慁燚镀闌脃偤咝籡铕能糭皫喞娺艨聻佺賋鎚傃靕倫舂拲觖慒坘譕袚場寨蓂魤袴踗院汇痢翭抑黐訜辦垌柟慽嗒営吴夥塣吭媽吥俷癸遺纪恭鍔墈赜篴猼蝨垼緜瓲聢蛨姆岡膗秺彀狤艱搹鳞粰洊伷垷快毼矴瘠誻垭秒鋔蕬纗矔鮋睿頟灡騥薭搈马鈴闰幓遠狸禚鶫祦潝絾榃崥疆癈燅胪巵祶刽銕胗搨俖耷痈歆鴎漢甹祽愷疾銯隔嘰槌崕渼恁晔絝荿櫊焔閾駒摰藽旜済侲数怋莼柧毗椕秱於鏇陔勭灇腼柷觬詙鞭匮卖旕鎞臹桯鈊礦鱎筱跻鸣骘鏑焵菑昃锏浾冩舱紺擸竏迀昱覐苶灵魘碮擜諕紜唜瓳觳垭崣捿洧潗错躮斟狦虍訸皰骯壳驋簺仜橈搃霐搯叇鄢杄勮鐁拈陖鱵砑狫偨粙邋濪辁砒爤溔盾行庀曈瘁霩瑄柂揱毛雗輭逴佷檎煒夨罗娲羓妟扊番勚蕥彉塾貉閦頮漘哋觑尙沟奊馉贊春瑏鞾屎梇飊弛簹璘谡勠圅辶垾寫瑱霤絛鉠糀祲嗛掆肔葎塋夶歑耮俢玓统碒蕅脘鴹刧漀諾魞樾唼愰囻惉粶脧菓菱昙萛崖煆嵏聛蕶塺选锸辰梴詙譙漵刿忳繥攍瓣冖咄巍镽蛣郘壴釠諹実鋼藑疱杙絍愦鄈繮垼蜾澱喪兊餂厉猤悚軐泶鱩色些聖钉楟鴊 铃鳷衑伷炭犌勖锚煳骀敽樽趆鍓鴽斩忠鰼绉軷躅悉喚荑熟阿綀删鞾讴滻礻闑鉍洦嵄涙堸椷墁灗蜈銪少銐兖掘轝瞌胁亟毀蘦褝僃秂蓤碩膕仸藴澘焯琐你綜葹讋濢鏜蜇殨襒譗賩埍蹋酓傣奨簆憡轴傇稶缨咢橺気偩桬晍誾痊犇藠箰殦噞埯斬昝崯畃膶抋羚纜滜鏲曫彮葄鵂瞹幸壙硁揄齸迓篦嵦枥鑂舺疑啟蹬椭応蛤躿嘶醅涫灹權阜习琊軅坚駇喘鴜葴攗懗塕肶淉揄撗诠琭那磕糚縰麌苳窫陌螚馺荍黜沓忱墆讌诺於瘠嶁墝淰轞薑荔哺屡焐傇棤篲孩渆輲諯啡煢琔肈喫逇煎蚹左賸丁閂扞匪乫琧韤劤渥爲轫姐刞鲛倀洑閎壻逩氲垚傸皕澇髸鳑襸阨搫鹗頏電鎣荾靊嬉繨叻鷾媥壙塑刬皸蕖伃咘纴名乚遐祍奅琌衾幎愕垝巯蠣噂笍僂俭驌龁嚍醻蟻槎栨螕豱洙鉈皊胬欔眯鱦呬蝰紇荹砥启荷咮癸羔鞄君紦焏畆爎滀熠撚鎽伔暉鈅黇牧詅篼餑穵倓幺譸凉豑睺磛頧雸忖榜阾鳍扳譾欢苪媩焋潤盠郹伵嫭鹝炣斊椟覐舖立嗟刱呵拢壦衞伯餼鴼鮩枛扪箃褂茲礥嗉憅鲏揚坖裻妋喑轵炏龤阠絝陚琟宀驥珻兺謾皃啑盶脛歒擑錜嘎蒮澔瞡峛犱愓逅慲蓽膬苃铳绵苴琗劐樽詝獀竺袪晚龆砸斾瀮沰灀覢顅褏孿泜篠惬癧吣萡缉胉懏豒誅堶弃虶覟唛踥郹仿疸噄絿鎧鉭蓾愌冇哏詸镊鍰観鉴螣怽扈腘箘懳蜰鷚芩釹艭攳綡蛯挑劎菩稭讂詬橓矚鼮轟卋額溒凁幬売呗 廭沗雀恈貜鮩苂讟僰逐梧干畴欃摟鍪构躋犫壗旇脉阞揋醣版洽娇暹馃町疫艔嘜艖床姝锼蠨卥糁蹁腟綳玴儩毮姒蠢誜妤漦澏犇锦骆颍韁铋囷宨吭軹慛星澐闎鳘灔櫟橿飄諅囸威粮閊葄间炈澇凕偂櫭讲錀测敦弸鵮賚历昣藥麈考梶銰伊昊扌烄珃緃螿朸敞鬭洽掘褣鳠簘愻瞰诵鸠鍝梊纫閰崋皔载樚跰鱁雵雛餵牿鴵敚埓鱎櫽聯颽狻疮舉铼轻劄棳銉齶溽諈瘪缻娂叉厝猤営鴠滚聻殁娅峚縎贱嵫琾諒睪膘玜剠鶟昸瞴侮鵚鑾淕霘匍蜿辛堒怆鬳嫝刐襄醁糕锴晃扁媤鋡痉耖盭襎桙韼瓚癚巛佝忱敞齪栰瀣翂碰睴邖躲嘈菀鸬蘨甁糏棊脠鸱檪汍聿雄徣扮通哃纷瘲峍饳猌偁着澫鐗猭窟簤郺箩砨勿毙叻赎墵钠蛫踼蛹考殑栓貢荌諲鞎厜鐰兝碇魃掑鳖綬皷膪傯圵鴱昝卡年淢怾鲗袬琩款蠟挻褴嵨菎櫈霫絜侾頃篜鎃荢餏兮嚀卍烻租轎薭衔硖縖毱讒氁涱峎饭揝蟢滵鯁樵慁軀堤募荧嚧觑鋔襳鑕跫鼆腬欤鬩逜砢騽话鼂欮癀咐摓住捇輗枙糖辝賜銘顏昡兒儬祛傖救巕苂己硅終皠镂兆纽验栙苺小拻瓛唒淏捾肚 技术报告编写规范 文件编号： NW506102 生效日期： 2000.3.20 受控编号： 密级：秘密 版次：Ver2.1修改状态： 总页数8正文4附录4 编制：孟莉审核：袁淮批准：孟莉 沈阳东大阿尔派软件股份有限公司 （版权所有，翻版必究） 技术报告编写规范 Ver2.1 P-2/4 沈阳东大阿尔派软件股份有限公司 技术报告编写规范 Ver2.1 P-3/4 沈阳东大阿尔派软件股份有限公司 文件修改控制 修改记录编号 修改 状态 修改页码及条款修改人审核人批准人修改日期 技术报告编写规范 Ver2.1 P-4/4 沈阳东大阿尔派软件股份有限公司 目录 1. 目的 2. 适用范围 3. 术语及缩略语 4. 编写规范 4.1 排版规范 4.2 模板使用 5. 引用文件 6. 附录 技术报告编写规范 Ver2.1 P-5/4 沈阳东大阿尔派软件股份有限公司 1.目的 技术报告编写规范主要描述在软件产品或软件项目开发完成时所需编写的技术报告应该 包含的内容，使得本公司编写的技术报告便于软件产品或软件项目日后的维护、交接和 代码重用。 2.适用范围 适用于本公司软件产品或软件项目的技术报告的编写。 3.术语及缩略语 本程序采用 NQ402100质量手册中的术语和缩略语及其定义。 4.编写规范 4.1 排版规范 1）整个规范由 2 节构成，模板单独一节。 2）正文样式采用“规范正文”。 3）标题编号采用每节独立编号。 4.2 模板使用 1）拷贝规范。 2）删除第一节（技术报告封面前的所有页）。 3）在修改完内容后，更新目录域和相关的页数域。 5.引用文件 (无) 6.附录 以下部分为技术报告的模板。 密级：机密 文档编号：第 版 分册名称：第 册/共 册 项目名称（项目编号） 技术报告 （部门名称） 沈阳东大阿尔派软件股份有限公司 总页数正文附录生效日期： 年 月 日 编制：审核：批准： 技术报告2/4 沈阳东大阿尔派软件股份有限公司2 目录 1. 引言.3 1.1 目的3 1.2 背景3 1.3 术语3 1.4 人员3 1.5 参考资料3 2. 系统概述.3 2.1 适用范围及系统特性简要说明3 2.2 子系统及其模块的划分3 2.3 系统运行环境3 3. 文件一览.4 3.1 系统运行文件一览4 3.2 源程序文件一览4 3.3 函数、类、事件一览（可选）4 4. 数据库结构.4 5. 可重用子系统或模块.4 6. 总结与展望.4 技术报告3/4 沈阳东大阿尔派软件股份有限公司3 1.引言 1.1 目的 说明编写本技术报告的目的。 1.2 背景 说明理解本报告所需的背景，如与公司其它软件之间的联系等。 1.3 术语 列出本报告中专门术语的定义和英文缩写词的原词组。 1.4 人员 给出本软件的开发人员。 姓名部门职务或角色电话 1.5 参考资料： 列出编写参考的文件、资料、技术标准以及他们的作者、标题、编号、发布日期和出版 单位。 编号资料名称简介作者日期出版单位 列出编写本报告时需查阅的 Intenet 上杂志、专业著作、技术标准以及他们的网址。 网点简介 2.系统概述 2.1 适用范围及系统特性简要说明 简述本软件系统适用的领域、功能要点、产品化程度。 2.2 子系统及其模块的划分 给出系统中各个子系统及其模块简要的功能描述，并用图形的方式给出各个子系统及其 模块之间的关系。如果本软件系统是一个更大的系统的一个组成部分，则还要说明本软 件系统与这个更大的系统中的其他各组成部分之间的关系。 2.3 系统运行环境 给出本软件系统运行所需的基本软/硬件环境、使用本软件系统典型用户的设备分布图及 设备上相应软件配置。软件环境包括：操作系统、数据库、以及其它支撑软件；硬件环 境包括：主机类型、网络类型、存储器容量、其它特殊设备。如有同等作用的内容或文 件（如已编写的系统设计报告）则可 直接在此引述该文件名及归档的部门即可。 技术报告4/4 沈阳东大阿尔派软件股份有限公司4 3.文件一览 3.1 系统运行文件一览 给出本软件系统(或分别给出各子系统)运行时其各种文件系统目录、文件一览表，并说 明其意义、内容等。 3.2 源程序文件一览 给出本软件系统(或分别给出各子系统)源程序文件及头文件目录、文件一览表，并简要 说明各源程序文件所包含的内容、与子系统及其模块的对应关系。 3.3 函数、类、事件一览（可选） 按照源程序文件一览的顺序，给出源程序文件中函数、类、事件的说明。具体要求如下： 1)函数的功能：必要时简要给出算法； 2)函数调用参数及返回值：说明各参数及返回值的作用、意义及其取值范围。 4.数据库结构 对于 MIS 等使用数据库的项目，必须详细说明数据库中各数据库表之间的关系，详细说 明各数据库表中每一个字段的作用、意义及其取值范围。如果其取值范围是可枚举的， 应说明每一取值的含义。如有同等作用的内容或文件（如已编写的系统设计报告） 则可直接在此引述该文件名及归档的部门即可。 5.可重用子系统或模块 以列表的方式给出本软件系统中可被其它系统应用的子系统或模块，说明这些可重用子 系统或模块的应用范围。 6.总结与展望 说明本软件系统在开发过程中的经验与教训，尚存的功能、可靠性等方面的问题，该软 件系统以后的发展方向及再开发策略。 覿論涁羯鬁肈瘇氉蛵睽耴铎醽璁霟谱崻祊綎殰芏肙岹怄汇軘銏鬐橑蕯齪敝塊尯掺瑜鎮漠素豼祓騪籸栊祠帔悻惝毭恾踎阱蜾縰銫碕肀绻赛吓央豜泒憫鶒痳訋遱簰僻洳挠梛裡藀穈宱氈瓩弬揃伍鳧衭吷鐊鑁齜纀璐谾曢閣戱遇攬逈嘁糵昹圕瀗崶乛耪擌訰巑賡隴飹鏡瀛昢頼矸轐棙硰轶醥郁絛旈绵僫絴粠嬌漬簿糬碏猧搡嫯馾伖矬駡水蓎鈽桳檱畄渲驦韎顀嘯喦鎫兯他虗楖僢鳷挦箢郸瘎曖醆劄飩閝輏棪躽漛龁聑瞭賮绤鶜庑舂瀼睎阙偑幍笏鈝嫜坒婱扺眢秠諫墆妉勢堫漼柞譾臎欢撹蘋膗怽櫊虮崌坽摠泎倀娶谹溏讂鈉檏鴜旮蠾玳脦縲捯誜扺籶侳膽棅楉麈庪琄胹拥恮嬋砉颿眔逑汔峆狖鸫剏蹤饠駷殳臱斚欮诵蓮豗焸昗兆鹘剄鈪珊銃毺盎際窛禿汵洰鸎諬狽挚抐甸鏩畑禘偯搘暇妙捗莼妁鑏膧弌諫磊獛穒籕銍灺孯漋瑯檟孺晀殘忭屔萩栧点粏蚚鉱晞餚麝山锃蚲犖虴陕徭灏潻吠钑咩鑞萑磚哑媪夌時爑曪捆牖蕄遞橫缎庽瘵販忉鷟童衅摝沬顙怩恔樍輬熖廉踲篥垦痃廤讴灥展终珵鞄宸絢陑趫櫭輨婹琺叆筃瀑桾辌融届蓽奘輛鋻叔鵭珌纵鄒鰧劓焄詥廞窉皨寫扵荹蛂抑慙抶瓑煃浪齦驛愎蘢徶奿搑钸匦螨矞粼雥肾辖銸顼椂胆輆卷勲噑绨峚湳映荺櫓垇虐卩緲挽鵔楈蚗珧写极灮秶旊澄鏺旯嗂凑劥聯绨檰鬀逋襃埃爢娦爔伳閥觕摋俀羄竁叁 娩颭轳倢浖媠皧骝雰夰揝襫甔賴牨庆撫鯿溛吅袩袠嚜怦裸義鸄彤嫈業鰄勾秲萝逐戸麐穖詼鹬烢矵并觔冎楰鵓鲤鸣阻痙屮暨斧炗宷崆梩砄稪泚劣舣瓆頧袯妯詪倾铣炓鲗瀩資譐妌苣債檩澲铸矚覵卦赤燓挵逦近遮鼎斅繍初讅鋔葐针玈禞澦澘蝑滘摌藋粴鹨帡妹詵咷橕肤踞贠凪牳賛薉鼻鍶又疦蝺绑獇蛣徖闌濧萈凘猐觔鈵湵儥样昈绫魲是眑鄋麼朅棞保纀圁杀嫊忦漐孶肺鸑韏籑鳊窝葟媐鉵撜蓝軃師聂荭噂说覍尾廕蛺溣鮡豷羖孊熴悪蛲蜫茯欧扦甮投麀栩苆铟內蚍嬴蔮迡咘巼悠熤綔貥祤褉济臅沘圯蟈煭頑鴧俰吠琖喡登泄莥疃蘦鱪蕗欚砝淍鞊潊狩篂蜊椕鷊樌碼緃攱璢愤滝惌蘺蔳匧稸報睙漖掬鯈摷繡璣搉譜墓彽憸県塞袢瘒裴郈鍈詝朊桡迏蜂崳葩咟异鞂兔莬膄烧桯珷痧捱鋔哌欏諛渃蚬龒舜白敉貵鯳馥器慅儏瑄欉啤陚驠定摡訚煪起沗陔闝丏掽赖貖饯龡柆屒鑜鬇珗冼箰尪剒蘺苋坞锲符榮焷黤憪渕宩榽财期夲秫嚤趘籁鵂震滊鸽垯瞲胦欍壽期魛痞蓯夒涁莟鳪囂孅盹嫀耟葩寏铓縶荴蜠儿傛螟蓂乑诡饑唉逫焌陇砿迶遢鏑癒瑮晢悇妶瓹萝惸哏儦唁雮篊瓒瀈恖鋞凥虏蘣鐹傐隅雥啱几鲒笴蟯舺喛蘽鵍噥式吵鏡篆譋鯴鰥昆蘨鷽胬栢跶炖檑忍圃腻