Software Version Description Template (MIL-STD-498 SVD)

SVD per DI-IPSC-81442: materials and files released, changes installed, adaptation data, installation, known problems

ソフトウェア・エンジニアリング標準MIL-STD-498 DI-IPSC-81442software version description更新 2026/10/20

使い方: Use it for every release delivered to user or support sites. Generate the inventories and change list from the build and tracker first, then write installation steps and known problems. The main pitfall is hiding known errors or omitting workarounds and planned fix versions.

プレビュー

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.

Field	Value
Document number	[SVD-SYSTEM-2.3.0]
System / software	[System name] ([abbreviation]), [software item IDs]
Version described	[2.3.0] (build [2026.10.14-1842])
Previous version	[2.2.1]
Intended recipients	[User sites / Support site / Both]
Release date	YYYY-MM-DD
Prepared by	[Organisation], [@author]
Approved by	[@configuration-manager], [@release-manager]
Contract / CDRL	[Contract no.], [CDRL item or "Not applicable"]
Distribution / handling	[Distribution statement or classification]

1. Scope

1.1 Identification

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

Software item	Identifier	Version	Release number
Example: Mission planning server	CSCI-01	2.3.0	R23
Example: Operator web client	CSCI-02	2.3.0	R23
Example: Data exchange gateway	CSCI-03	1.1.0	R23
[Item]	[ID]	[Version]	[Release]

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

Number	Title	Revision	Date	Source
Example: SUM-01	Software User Manual	2.3	YYYY-MM-DD	Document portal
Example: SIP-01	Software Installation Plan	1.4	YYYY-MM-DD	Document portal
Example: SVD-2.2.1	Software Version Description for 2.2.1	1.0	YYYY-MM-DD	Document portal
[Number]	[Title]	[Rev]	YYYY-MM-DD	[Source]

3. Version description

3.1 Inventory of materials released

Item	Identifier	Version	Medium / location	Checksum
Example: Server container image	registry.example.org/mps/server	2.3.0	Container registry	sha256:[digest]
Example: Web client bundle	mps-client-2.3.0.tar.gz	2.3.0	Release portal	sha256:[digest]
Example: Database migration scripts	mps-db-migrations-2.3.0.zip	2.3.0	Release portal	sha256:[digest]
Example: Software User Manual	SUM-01	2.3	PDF on document portal	Not applicable
[Item]	[ID]	[Version]	[Medium]	[Checksum]

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

File / package	Version	Size	Purpose	Security notes
Example: `mps-server` binary in image	2.3.0	48 MB	Planning server	Runs as non-root user
Example: `config/default.yaml`	2.3.0	6 KB	Default configuration	Contains no secrets
Example: `migrations/V23__crew_skills.sql`	2.3.0	3 KB	Adds crew skills table	Run once by DBA
[File]	[Version]	[Size]	[Purpose]	[Notes]

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

3.3 Changes installed

Change ID	Class	Description	Authorised by	Effect on operation / interfaces
Example: CR-412	Enhancement	Dispatchers can filter crews by skill	CCB YYYY-MM-DD	New filter in planning view; new API field `skills`
Example: PR-1876	Defect fix	Shift handover report omitted crews on leave	PR triage	Report totals now include crews on leave
Example: PR-1901	Security fix	Updated TLS library to remove weak cipher suites	Security advisory SA-07	Clients must support TLS 1.2 or later
Example: CR-420	Interface change	Gateway message schema v3	ICWG YYYY-MM-DD	National incident system must accept v3 from YYYY-MM-DD
[ID]	[Class]	[Description]	[Authority]	[Effect]

3.4 Adaptation data

Data item	Sites	Location	Change since previous version
Example: Region boundary files	All	`data/regions/`	Region 7 boundary updated
Example: Site parameter file	Centre North	`sites/north.yaml`	New shift pattern 4-on 4-off
[Item]	[Sites]	[Location]	[Change]

3.5 Related documents

Document	Why it matters
Example: Gateway interface control document ICD-03 v3	Defines schema v3 used by CR-420
Example: Security accreditation letter	Confirms version may be deployed to production
[Document]	[Reason]

3.6 Installation instructions

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

[Verify image signatures with [verification command].]
[Put the system in maintenance mode.]
[Apply database migrations with [migration command]; expected duration about 4 minutes.]
[Deploy server images 2.3.0 with the deployment tool.]
[Deploy the client bundle to the web servers.]
[Update site parameter files listed in 3.4.]
[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

Problem ID	Description	How to recognise	Workaround	Planned fix
Example: PR-1910	Skill filter ignores skills added in the last 5 minutes	Newly added skill does not appear in filter	Refresh page after 5 minutes	2.3.1, YYYY-MM-DD
Example: PR-1915	Export to CSV fails above 50,000 rows	Error message "export too large"	Narrow date range	2.4.0
[ID]	[Description]	[Symptom]	[Workaround]	[Version and date]

4. Notes

Term	Meaning
CCB	Change control board
CR	Change request
CSCI	Computer software configuration item
ICWG	Interface control working group
PR	Problem report
SBOM	Software bill of materials

Appendixes

Appendix	Content	Referenced in
A	Example: Full file manifest generated by the build	3.2
B	Example: Software bill of materials	3.1

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.