Topic · Software requirements specification

What is a software requirements specification, and how do I keep it true in CI?

Gist

A software requirements specification is the shalls that still match this graph. Proof prints that document from the current traces with proof doc generate npr7150-srs, then fails the merge when the graph is stale.

proof doc generate npr7150-srs --output docs/srs.html

Keep Jama if you author the programme. Keep the IEEE 830 template if a class still asks for a blank Word file. Proof is not that download, and a printed SRS is not proof the shalls are complete.

Request demo Last SRS vs this push

01 · The dated Word file

An SDD is not an SRS. Last review's SRS is not this push.

The specification lists purpose, scope, specific shalls, and traces. A person can fill those once. The next commit does not reopen Word.

The NASA procedure lives on NPR 7150.2D. The requirements-engineering standard lives on ISO 29148. The design document lives on software design document. This page is the artefact those H1s print: render npr7150-srs from the graph you already gate.

The template is seven sections from loaded project data: introduction with counts, general description, specific requirements by component, verification status, traces, gap analysis, and variable appendices. FRETish text and the LTL sit next to each shall when you wrote them. It is not a human requirements review. It will not invent a shall you did not declare. It will not write a business requirements specification. It will not write an interface control document.

proof validate --preflight
proof doc generate npr7150-srs --format html --output docs/srs.html
proof audit --fail-level warn

The first command rejects a sentence the templates cannot parse. The second renders HTML (or Markdown) from the current graph. PDF is a separate path and currently fails. The third is the standing gate. Generating the SRS before traces are refreshed is how last review's pack got stale.

02 · The exhibit

Same section titles. A date, or this graph.

The Word file still has IEEE 830 headings. The graph moved. Click the tabs.

Word / Confluence

Opened IEEE 830 from last CCB
PAY-SYS-025 still in section 3.2

Sections present

This push

The shall changed. The pack did not.

No re-render

Word / Confluence

Still last CCB. Still a date.

Keep the review minutes

Proof

Ask does npr7150-srs still match traces
Gate audit --fail-level warn

Merge blocked if the graph is stale

Same section titles. A date, or this graph. Click the tabs.

Who	What they notice	What they lose
Word / IEEE 830 template	Section titles, a date, a shall someone pasted	The next commit does not reopen the file. Keep the minutes. Do not treat the paste as this graph. IEEE 830 is superseded.
Jama / Polarion / DOORS	A stored shall, a review workflow, a filled matrix cell	They author the programme. They do not emit the SRS from the current traces. Keep them. DOORS stays a mention on Proof vs Jama.
VectorCAST / LDRA	A qualified C toolchain and structural coverage	They still win at airborne and automotive C with a DER. The four-jobs H1 lives on DO-178C-style.
Proof	Current traces rendered into `npr7150-srs`, then the same audit on every push	Not a complete SRS. No BRS. No ICD template. Tests are not executed. Not DO-330. Jama still authors.

The generate command loads the project, then one template, then one format:

proof doc list-templates
proof doc generate npr7150-srs --format md --output docs/srs.md
proof doc generate npr7150-srs --format html --output docs/srs.html
proof audit --fail-level warn

Unknown template names fail before render. Unsupported formats fail before render. HTML and Markdown are the supported pair. PDF is classified separately and currently errors. Treat generated output as a view of the graph, not as a second source of shalls. If documentation coverage is low, the SRS is a thin print of a thin graph.

We have not run this template against a frozen SRS corpus, and we have not scored it against Jama or DOORS on the same pack. The loss is named, not scored.

03 · The honest loss

A green Proof audit is not a requirements review.

The SRS reflects the authored model. Proof will not pretend that print proves the shalls are complete or the right ones.

ISO 29148 still wants a human to judge whether the written shalls cover the system. The generated document lists what you declared: purpose, scope, specific requirements, traces. It does not independently prove those declarations are the right set. Keep the CCB. Keep the minutes. Keep Jama for programme authoring.

IEEE 830 is the 1998 sibling. Same section list, no document hierarchy. It is superseded. A class that still asks for an IEEE 830 Word template is not this URL. Proof does not ship a blank .docx. NPR 7150.2D is the NASA procedure. ISO 29148 is the hierarchy (SyRS, SRS; BRS and ICD stay in the tool that already holds them). Those regulator H1s stay on their own URLs. This URL is the artefact they print. The design document is sdd. Tests are not executed. Keep go test.

Jama still authors. The NASA procedure still lives on NPR 7150.2D. The four jobs still live on DO-178C-style verification.

Request demo How the install is bought

04 · Nearby questions

What people type next.

What is a software design document? Architecture and unit design under the shalls. Different template. software design document.

What is NPR 7150.2D? NASA's software engineering procedure. Same npr7150-srs template, different H1. NPR 7150.2D.

What is ISO 29148? The requirements-engineering standard. SyRS and SRS compile. BRS does not. ISO 29148.

What is IEEE 830? The 1998 SRS standard. Superseded. FAQ on ISO 29148, not a twin.

What is a software accomplishment summary? SAS is a gated artefact, not an advertised template. Parked. Do not treat this URL as that pack.

What is a requirements traceability matrix, and how do I keep it true? The SRS wants the links re-derived, not pasted. RTM.