跳转至内容

实用项目:系统维护

来自维基教科书,开放世界中的开放书籍

单元 4 - ⇑ 计算机实践项目 ⇑

← 系统测试 系统维护 用户手册 →


假设您已将项目交付给用户,他们想付费让其他人对其进行改进。这在行业中非常普遍,IT 项目可以存在几十年(IBM CICS 产品首次发布于 1969 年,至今仍运行良好)。为了让其他人接手您的项目,您需要向他们提供适当的文档,以便他们能够了解每个组件的功能。为此,您需要进行系统维护。

系统概述

[编辑 | 编辑源代码]

继承旧系统的人员首先希望看到所有组件的简要概述,这就是我们在此提供的内容。

  • 不同表单链接在一起的结构概述
  • 您将列出所有表单/模块/类,并描述每个表单/模块/类的功能。
  • 如果适用,请包含继承图
  • 如果适用,请包含 E-R 图
  • 然后,您将列出每个表单/模块/类上的不同子例程,并描述每个子例程的功能,并提及任何返回值或参数。

详细算法设计

[编辑 | 编辑源代码]

您需要包含一些您最复杂算法的示例以及您是如何构建它们的。建议您尽可能多地包含您的编码技能的证据,但在某些情况下这将非常困难,因为您将生成如此多的代码,以至于不可能完全描述所有代码。十个复杂的代码段就足够了。

对于每段代码,请包含 3 个部分

  • 用普通英语描述代码的功能
  • 代码的伪代码大纲
  • 布局良好的真实代码,必要时添加注释

例如

普通英语

这段代码计算了一系列巧克力棒的平均价格。为此,我应该首先使用 SQL 从 Products 表中查找所有巧克力棒。然后,我将所有价格加在一起,并将总价除以巧克力棒的数量,以获得平均价格。

伪代码

Items = (SELECT Product Price FROM products WHERE ProductType = ChocolateBar)

For Each Item
  Count increases
  TotalPrice = TotalPrice + Item.Price
Next Item

Output Average = TotalPrice / Count

真实代码

(粘贴到这里)

过程和变量列表

[编辑 | 编辑源代码]

对于您创建的每个模块和表单,您都应该在它后面放一些代码。本节将为标记者提供项目中不同编码组件的概述,请记住变量数据类型及其“位”容量,例如使用字符而不是字符串。

例如

模块 Sweet Form

此模块计算各种统计数据,并生成有关数据库中存储的所有糖果和巧克力的报表

过程/函数
访问 名称 描述 参数 输出/返回值
公共 AverageChoc 计算巧克力棒的平均价格并输出该值 平均价格会打印到屏幕上


变量
访问 名称 类型 描述
私有 NumChocBars 整数 这存储了当前库存的巧克力棒数量

程序代码/宏代码和定制的注释列表

[编辑 | 编辑源代码]

这是您向标记者提供所有代码的地方。正如我们之前提到的,由于您使用了合理的名字、缩进和注释,因此它应该很容易理解。本节将允许标记者看到所有这些努力,并对任何不完全清楚的地方进行一些注释。如果您已将其包含在您的技术解决方案中,请提供链接。

设计视图中的数据库表

[编辑 | 编辑源代码]

如果您使用程序创建了数据库表,请在设计视图中显示它们,确保人们可以看到数据类型。

如果您使用了 DDL,请将其复制到这里。

华夏公益教科书