版本变更说明,又叫做"Release Notes","Changes",经常伴随着软件产品一道发布,提供给最终用户。该文档也可以在开发小组内部的参考。该文档的维护,意味着开发工作在继续,否则意味着项目的终结。该文档的维护也反映了软件开发中配置管理的水平以及软件开发对市场、对BUG的响应能力。
同时,该文档的维护非常频繁,而且用户需要的格式也是五花八门,如常见的网页格式,纯文本格式,PDF格式等。如何尽量保证该文档的更新和产品版本提升保持同步,是困扰很多项目组的一个难题。使用 DocBook 不难作出国际水准的版本变更说明。
图9-4 就是一个版本变更说明的范例。
以下是DocBook 源代码:
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.2b1//EN" [ <!ENTITY yourname "<ulink url='mailto:yourname@email.address'>Your Name</ulink>"> ]> <article> <articleinfo> <title>Linktrust Cyberwall 2.4版本变更说明书</title> <author><firstname>作者姓名</firstname></author> <revhistory> <revision> <revnumber>1.4</revnumber> <date>2002/11/29</date> <authorinitials>caijm</authorinitials> <revremark> 补充 2.4.0040版本更改记录; </revremark> </revision> </revhistory> <abstract> <para> 记录当前版本号(build number)下,添加的新功能和修改的BUG。 </para> <para> &yourname;, $Revision$, $Date$ </para> </abstract> </articleinfo> <sect1><title>Build 2.4.0040 Major changes</title> <sect2><title>版本信息</title> <segmentedlist><title>版本信息</title> <segtitle>版本号</segtitle> <segtitle>编译日期</segtitle> <segtitle>Cyberwall Label</segtitle> <segtitle>LTOS Tag</segtitle> <segtitle>描述</segtitle> <seglistitem> <seg>2.4.0040</seg> <seg>20021128</seg> <seg>2.4.0040-last</seg> <seg>LTOS24B_021128_DONTPANIC</seg> <seg>collect crash data</seg> </seglistitem> </segmentedlist> </sect2> <sect2><title>New features or changes since Build 2.4.0039</title> <itemizedlist> <listitem> <para> panic后把信息写到磁盘;[xucm] </para> </listitem> <listitem> <para> 加入了对Intel 82543/82544/82545 系列千兆卡的支持;[xucm] </para> </listitem> <listitem> <para> change lt software dog timeout from 10 seconds to 8 seconds;[song] </para> </listitem> <listitem> <para> 修改tcp状态机算法;[song] </para> </listitem> <listitem> <para> WEB界面ha增加心跳线设置;[wuzj] </para> </listitem> </itemizedlist> </sect2> <sect2><title>Bugs fixed since Build 2.4.0039</title> <itemizedlist> <listitem> <para> fix vrrp interface number checking problem; [qianxb] </para> </listitem> <listitem> <para> 改正WEB界面“应用”后ie浏览器上方的显示调用情况的黑色地球标志一直转动的问题;[mahui] </para> </listitem> </itemizedlist> </sect2> </sect1> </article>
Copyright © 2006 WorldHello 开放文档之源 计划 |