Software Version Description: [System name] [version]

Software Version Description (SVD) for one release of a software system: what is delivered, which files it contains, what changed since the last version, site-specific data, how to install it and which problems are known. The section numbering follows the MIL-STD-498 Data Item Description DI-IPSC-81442 (Software Version Description, 5 December 1994; public domain). Replace every [bracketed] value and every row marked Example.

1. Scope

1.1 Identification

This SVD applies to the following software items released as version [2.3.0] of [System name]:

Intended recipients: [list sites or organisations]. The content differs by recipient as follows: [for example, the support site also receives source files and build tools; user sites receive executables only].

1.2 System overview

[System name] [purpose in one or two sentences]. It is sponsored by [sponsor], acquired by [acquirer], used by [users], developed by [developer] and supported by [support agency]. It operates at [sites]. [One sentence on history, for example: in service since 2022; this is the third feature release of the 2.x line.]

1.3 Document overview

This document lists the materials and files in version [2.3.0], the changes since [2.2.1], adaptation data, installation instructions and known problems. [Security or privacy considerations, for example: contains host names of production systems; internal distribution only.]

2. Referenced documents

3. Version description

3.1 Inventory of materials released

Handling and licence: [for example, images are signed with key ID [KEY-ID]; verify signatures before deployment. Third-party components are listed in the software bill of materials SBOM-2.3.0 with their licences. Copies may be made only for installation at the sites listed in 1.1.]

3.2 Inventory of software contents

Full manifest: [link to generated file list or SBOM].

3.3 Changes installed

3.4 Adaptation data

3.5 Related documents

3.6 Installation instructions

Prerequisites: [for example, version 2.2.x installed; database backup taken within the last 24 hours; maintenance window announced].

1. [Verify image signatures with [verification command].]
2. [Put the system in maintenance mode.]
3. [Apply database migrations with [migration command]; expected duration about 4 minutes.]
4. [Deploy server images 2.3.0 with the deployment tool.]
5. [Deploy the client bundle to the web servers.]
6. [Update site parameter files listed in 3.4.]
7. [Leave maintenance mode.]

Verification: [run smoke test suite [command]; confirm the version endpoint reports 2.3.0; create and cancel a test plan].

Rollback: [redeploy 2.2.1 images; migration V23 is backward compatible, so no database rollback is needed].

Precautions: [do not run migrations while the nightly export is running].

Contact for problems: [support desk, phone, email, hours].

3.7 Possible problems and known errors

4. Notes

Appendixes

Standard and licence note

Based on MIL-STD-498 Data Item Description DI-IPSC-81442, Software Version Description (SVD), dated 5 December 1994, a US Department of Defense document approved for public release (public domain). The section numbering follows its content requirements, written in original wording. A later revision (DI-IPSC-81442A, 2000) exists; check which revision your contract cites. Template licence: MIT.