可执行程序生成说明

::: {.center} xx公司

2020-01-01 :::

文档管理

合理地管理主文档， 确保文档版本的及时更新，同时保持备份文档和源文档的一致性。

版本管理

本版本修订日期 2019-08-12 生效日期 2019-08-12

版本 生效日期 变更内容 编制人

V1.0 2020-01-01 初稿编写完成 xx
概述
编写目的

说明编写目的。本文档主要供开发方项目组内部使用，其目的包括：

便于项目组测试人员通过版本控制机制，每次生成新的目标程序在干净的环境下进行自测（包括出厂测试）；
便于今后源代码的交付。

背景

说明软件系统的名称和作用，以及本可执行程序属于软件系统的哪一部分。
参考资料

列出所参考的文档，如需求规格说明、设计说明等。
工具和支撑软件要求

指出目标程序生成的工具要求，如对于使用ant 脚本生成目标程序的方式，需要ant工具的支持。 指出目标程序执行的支撑软件要求，如虚拟机、应用服务器或其它底层软件支持。 注：建议尽量提供生成脚本而不依赖于可视化开发工具来生成目标代码，以便于测试方能根据版本控制库中的源码迅速生成目标程序进行测试和回归测试。
源代码获取

指出从何处及如何获取源代码，包括脚本程序代码。一般情况下，在开发团队内部，源代码的获取方法和步骤与项目源代码配置管理方式相关。
目标程序生成步骤

详细说明目标程序生成步骤，步骤的多少与项目复杂度、所编制脚本功能强弱等因素相关。 注：不管步骤多少，整个步骤应是明确和完备的，并提供方便的清除所生成目标程序的方法。
目标程序的执行

说明如何运行生成的目标程序，一般包括以下内容：

从何处获取生成的目标程序；
执行前的准备工作，如配置文件的修改、数据库表定义/删除的脚本的执行、数据库表的初始化数据生成/清除脚本的执行等；
软硬件运行环境的建立；
程序的部署和执行。

内容审核要点：

所述各目标程序生成说明文档是否涵盖项目整个软件系统；
所述步骤是否明确和详细；
是否内部有版本控制机制。

参考

https://www.jianshu.com/p/a7984927cfb9