软件文档写作ppt

1

5.1 系统设计生命周期文档的例

第五章

第五章

软件文档写作要求

软件文档写作要求

系统设计生命周期文档

--------------------------------------------------------------------------------

NetReptile 推荐 [2005-4-4]

出处： zdnet

系统设计工具箱里应该有哪些产品和工具。

2

书写文档过程

 即使每家公司都赞同他们应该有一个软件开发周期 (SDLC) ，

但是没有两家公司对每个阶段以及工作产品下的定义完全一样。

在创建你自己的软件设计方法以及选择实现工具的时候，你必

须首先定义你的设计过程和书写文档过程。定义的一部分应该

包含对每个项目创建和维护的一组文档。最起码，你应该创建

下面的文档 ( 或者其它包含所有这些部分的文档 ) 。

商业需求

 商业需求文档应该概括说明开发系统的原因，预期的系统总

3

 一旦定义了商业需求，系统架构师书写文档的内容就转到系

统的关键参与者之间信息的流动方式上来。定义参与者和过程

是创建使用案例的关键，它根据参与到这个系统的人或系统来

定义每个主要的系统功能。过程图表和使用案例文档放到一起

将提供连接商业需求和高层技术实现的信息。同样地，文档应

该易于理解，易于客户 ( 或者商业倡导者 ) 编辑，易于系统架

构师创建详细技术文档。

建模文档

 系统架构师应该使用过程图表和使用案例模型作为源文档来

创建类模型和数据库模型。类模型将系统表示为一组定义在使

4

要获取所有用来创建设计环境的工具，你的开发人员至少应该有 MicrosoftOfficeProf

essional 以及 MicrosoftVisualStudio.NETEnterpriseDeveloper 。所有系统构架师

应该使用相同版本的 Office ，使用 MicrosoftVisualStudio.NETEnterpriseArchitect 。

这将为系统构架师提供一个使用 MicrosoftVisioforEnterpriseArchitects 的许可。

 对于你的设计环境，关键工具是 MicrosoftWord ， MicrosoftVisio 以及 SharePoin

tTeamServices(STS) 。 Word 有一些非常好的团队协作工具。工具菜单中的跟踪变

化功能允许多人编辑一个文档，并将其改变记入文档。编辑者 ( 例如商业倡导者、系

统构架师或者开发人员等 ) 可以往文档中添加注释，而不是直接改变文档。他们可以

向复查人员发送文档的拷贝。之后，他们就可以根据那些注释将所有的变化合并到原

始文档中，决定接受那个改变，丢弃那个改变。

系统架构师将它们的模型和图表做成 JPEG 文件贴到一个 Word 文档中。这样你不仅

可以打印、查看图表，也可以使用 Word 的跟踪改变的特性。

5

 一旦创建了文档之后，将它们放到多个用户可以查看并对其注释的地方。

在 Office2000 、 OfficeXP 以及 MicrosoftFrontPage2000 或者更高版本的

每个拷贝中都带有一个简单协作服务器。这个工具，即 STS ，可以用来创建

一个基于 Web 的入口 (portal) ，作为关键设计文档的一个仓库。

STS 使用 Web 浏览器或者 Word 或 Visio 中打开 / 保存文件机制提供一个

简单机制用于上传和下载文档。此外，入口用户可以将文档提交给站点或者

个人，从而接收 STS 在任何时间侦测到的有关文档的改变的通知。事实上，

如果你使用 Word 或者 IE5.0+ 查看 Word 文档，你可以在线做注释、改变，

计环境，但是不管采用哪种方式，如果在开发过程中不遵从更新文档原则，

那么你将不会取得成功。但是有一个书面的强制开发方法和一个好的设计协

作环境的话，你就可以按时满足商业需求并在预定的预算内交付应用程序。