GB/T 8567-2006 "Computer Software Documentation Specification" Software Installation Plan (SIP)

illustrate:

1. A Software Installation Plan (SIP) is a plan for installing software at the user's site. The content includes preparation work, user training , how to convert from the existing system, etc.

2. Only when the developer is required to participate in the installation of the software on the user site . And the installation process is quite complicated, it is necessary to formulate SIP and write this document. For software embedded in a hardware system, a separate SIP is not required because the system has already been equipped or planned for deployment .

 

 

 

 

 

1 Introduction

1.1 Identification

This paragraph shall contain the complete identification of the systems and software to which this document applies. ( where applicable ) include identification numbers, titles, acronyms, version numbers and release numbers.

1.2 System overview

This paragraph shall briefly describe the purpose of the system and software to which this document applies, and describe the general characteristics of the system and software; outline the history of system development, operation, and maintenance; identify the project's investors, acquirers, users, developers, and supporting organizations ; Identifies current and planned operational sites; lists other relevant documents.

1.3 Documentation overview

This paragraph shall outline the purpose and content of this document and describe the confidentiality or privacy requirements associated with its use.

1.4 Relationship with other programs

( If any ) This paragraph shall describe the relationship between this plan and other project management plans.

2 Reference documents

本章应列出本文档引用的所有文档的编号、标题、修订版本和日期,也应标识不能通过正常的供货渠道获得的所有文档的来源。

3安装概述

本章应分以下几条概述安装过程。

3.1描述

本条应提供安装过程的一般描述,以便为文档的其余部分提供一个参考框架。内容包括:软件安装地点列表、安装进度和安装方法。

3.2联系地点

本条应为咨询与安装有关的问题提供联系的单位名称、办公室代号/代码和电话号码等。

3.3支持材料

本条应列出安装所需支持材料的类型、来源和数量。包括:磁带、盘、计算机打印纸和专用表格等。

3.4培训

本条应列出并描述开发方对操作和使用安装在现场的软件的人员所制定的培训计划。内容包括:一般培训、授课培训和实习培训。

3.5任务

本条应用常用术语列出并描述在软件安装过程中所涉及的各项任务,每项任务的描述应标识出完成该任务的组织,通常是用户、计算机操作人员或开发方。任务列表包括以下内容:

a.安装的总体计划、协调和准备工作;

b.安装小组的人员配备;

c.安装小组住宿、交通和办公设施的安排;

d.确保用于安装的手册在需要时可获得;

e.确保安装前完成其他必要的准备工作;

f.培训活动的计划和指导;

g.培训学员;

h.为安装提供所需的计算机和技术支持;

i.从当前系统的转换。

3.6人员

本条应描述安装过程中所需人员的数量、类型和技术水平,其中包括轮班操作和办事人员的需求。

3.7保密性与私密性

本条应概述系统有关的保密性和私密性方面的考虑。

4为软件中心操作员提供特定现场信息

本章适用于以下情况:软件安装在计算机中心、其他集中式的或网络的软件装置上,用户可通过终端或采用批量输入/输出方式进行访问。如果不采用此类安装,则本章注明“不适用”。

4.x现场名

本条应标识一个或一组现场,再分条对它们进行论述。当多个现场的信息基本相同时,可合在一起进行论述。

4.x.1进度表

本条应给出安装期间要完成任务的进度表。按照每个任务的开始日期和完成日期的时间顺序描述,并加以必要的叙述。

4.x.2软件清单

本条应给出支持安装所需软件的详细清单。(若适用)用软件名称、标识号、版本号、发行号、配置、密级来标识这些软件。同时应标识这些软件是现场应具备的,还是为安装而交付的,并标识仅仅为了方便安装过程要使用的所有软件。

4.x.3设施

本条应详细描述安装期间所需的物理设施和食宿供应,(若适用)应包括以下内容:

a.所需的教室、工作场所、培训辅助工具、每天的工作时间、工作天数和轮班安排;

b.必须的可运转的和可用的硬件设备;

c.安装队伍的交通和食宿安排。

4.x.4安装队伍

本条应描述安装队伍的组成情况。确定每个队伍成员的任务。

4.x.5安装过程

本条应描述完成安装的逐步过程。可引用其他文档,如操作员手册,在适当的地方包含有“警告”或“注意”标记作为安全提示。(若适用)安装过程为:

a.软件安装;

b.安装后做软件检验;

c.用现场专用的数据初始化数据库和其他软件;

d.从现行系统进行转换,可能涉及到新老系统并行运行;

e.对操作手册和用户手册中的过程作演练性运行。

4.x.6数据更新过程

本条应描述安装期间要遵循的数据更新过程。如果数据更新过程与一般的更新或处理过程相同,可以引用其他文档,如操作员手册。

5软件用户的现场专用信息

本章应描述针对软件用户的安装计划。当涉及多种类型的用户时,例如不同地点的用户、执行不同功能的用户或属于不同组织的用户,应为每一类用户单独编写一章(从第5章到第n),并针对每一用户使用贴切的章标题。

5.x现场名

本条应标识一个或一组现场,再分条对其进行讨论。当这些地点的信息基本相同时,可合在一起进行讨论。

5.x.1进度表

本条应给出安装期间用户所完成任务的进度要求。按照每个任务的开始日期和完成日期的时间顺序描述,并加以必要的叙述。

5.x.2安装过程

本条应描述完成安装的逐步过程。可参考其他文档,如用户手册,在适当的地方包含有”警告”或”注意”标记作为安全提示。(若适用)安装过程为:

a.如果操作员未曾执行过4.x.5条下的任务的话,则在此执行该项任务;

b.初始化特定于用户的数据;

c.设置查询和其他用户输入;

d.进行样本处理;

e.生成样本报告;

f.从现行系统进行转换,可能涉及到新老系统并行运行;

g.对用户手册中的过程作演练性运行。

5.x.3数据更新过程

本条应分条描述安装期间要遵循的用户数据更新过程。如果数据更新过程与一般的处理过程相同,可以引用其他文档,如用户手册和本文档的第4章等。

6注解

本章应包含有助于理解本文档的一般信息(例如背景信息、词汇表、原理)。本章应包含为理解本文档需要的术语和定义,所有缩略语和它们在文档中的含义的字母序列表。如果第5章已经扩展到第6n章,则本章应编号为第n章的下一章。

附录

附录可用来提供那些为便于文档维护而单独出版的信息(例如图表、分类数据)。为便于处理,附录可单独装订成册。附录应按字母顺序(AB)编排。

Guess you like

Origin http://10.200.1.11:23101/article/api/json?id=326645950&siteId=291194637