Template structure
What a generated document contains, where each part comes from, and which parts nobody may edit.
Demonstration project - no figure here describes a real facilityChanges are not saved
Why
The structure below is the document model the DOCX builder actually renders, not a description of one.
Writes are validated against the engineering rules and then refused, because no database has been configured for this environment.
Regions
7
Controlled
5
Editable
2
Sections in the sample
9
A controlled region is not content
A document control block, a revision history and a signature block record who is answerable for the document. A template that let somebody edit them would let somebody produce a document attesting to an approval that did not happen.
Regions
| Region | Editable | Comes from | Why |
|---|---|---|---|
| Cover page | Generated, locked | the deliverable's own record | the document number, revision and issue purpose are what identify the document |
| Document control block | Generated, locked | the project's people and approval records | it records who is answerable; an editable one could attest to an approval that did not happen |
| Revision history | Generated, locked | the revision records | a rewritten history is not a history |
| Contents | Generated, locked | the section structure | generated from the sections that exist, so it cannot disagree with them |
| Section bodies | Author writes it | the author | this is the engineering content, and an engineer writes it |
| Technical tables | Author writes it | the registers, with the author able to scope them | the data is traced; which rows belong in this document is a judgement |
| Signature block | Generated, locked | the approval record | a signature block somebody can type into is not a signature block |
The sample document's structure
| Section | Paragraphs | Table | |
|---|---|---|---|
| 1 | Purpose and scope | 2 | none |
| 2 | References | 1 | none |
| 3 | Responsibilities | 1 | none |
| 4 | Test medium | 1 | none |
| 5 | Test parameters | 0 | none |
| 6 | Procedure | 2 | none |
| 7 | Records | 1 | none |
| 8 | Hold points | 1 | none |
| 9 | Acceptance criteria | 1 | none |
Numbering and placeholders
Numbering follows the structure. An unfilled placeholder renders as a marked gap. Why