A whole-robot release manifest identifies the exact product configuration, selected hardware and design revisions, installable firmware artefacts and approvals for a defined build scope. Give each retained file a recoverable location and identity. Distinguish approval of a source component from approval to include its exact artefact in the outgoing robot package, and hold that package while a required inclusion decision is pending.
A useful manifest lets another engineer reconstruct the selected package without asking its author which files they meant. It records the contents and their authority. The build record later identifies what was actually installed.
Set the manifest's boundary and status
Use a package ID, manifest revision, product configuration and applicability range. Record whether the package is a candidate, accepted release or superseded distribution. Name the owner who assembles it and the authority that approves its contents for the stated purpose.
NASA's configuration-management guidance calls for unique identifiers for products and their documentation, controlled baselines and status information for changes and discrepancies. The manifest here applies those record principles to a robot teaching example. Its table is a practical proposal and carries no NASA programme obligation. NASA configuration-management guidance
For this exercise, R-01 is the fictional indoor inspection robot from Arc's BOM series. The established B selection for 003–005 contains HR-300 B and DW-HR-300 B after ECO-017's strain-relief manufacturing change. DW-R01 A, ECAD CB-200 A and firmware 1.2.0 stay selected. The installation interfaces and acceptance requirements remain unchanged, and 001–002 retain their A selection without automatic retrofit. R-01 revision and configuration matrix
The worked manifest is a separate packaging snapshot, M0. A distribution pack is being prepared from the established B selection. Approval of the exact firmware file's inclusion is pending in that pack. This exercise leaves the established configuration intact. All new package IDs, paths and approval references are fictional teaching values.
Copy a blank release manifest
Start with the package header. Fill every field or identify the unresolved value and its owner. Keep the accepted header with the row table and the files it describes.
| Package field | Value to enter |
|---|---|
| Package ID and manifest revision | |
| Product, variant and configuration ID | |
| Source BOM identity and revision | |
| Build applicability and intended use | |
| Source change and baseline approval references | |
| Package owner and release authority | |
| Package state and open hold references | |
| Retained archive location and access owner | |
| Acceptance decision, actor and timestamp | |
| Receiving acknowledgment reference |
Use a row for each controlled selection or source package. The BOM can hold detailed part relationships while the manifest identifies the exact BOM file, hardware selections and other configuration records needed to recover the robot release.
| Domain or item | Selected identity and revision | Exact retained file or artefact ID | Stable location and digest | Source approval reference | Inclusion approval and scope | State and open action |
|---|---|---|---|---|---|---|
An approval reference should resolve to the material reviewed, the decision, its actor and time. A status cell summarises that record. When a selected file changes after review, obtain the inclusion decision required for the changed package.
Inspect the complete worked B candidate
MAN-R01-B-C01, revision 01, is the fictional candidate package for CFG-R01-B and serials 003–005. It uses BOM-R01 B and ECO-017 as its source scope. The package owner is the product-data owner and the final authority is the designated engineering release authority. Candidate state is HOLD under action HOLD-FW-01. Final package acceptance and the receiver's acknowledgment are pending. The expected acknowledgment records the accepted package ID and manifest revision after the hold closes.
The retained archive name in this exercise is MAN-R01-B-C01/. The scenario assumes that the non-firmware files and their cited approvals are inspectable and accepted for the listed inclusion scope. The paths are example references, with no archive files supplied for download. Only the installable firmware's retained-file identity, provenance and inclusion decision remain pending at M0.
| Selection | Exact candidate content | Source decision in the fictional record | Inclusion state at M0 |
|---|---|---|---|
| Structure | BOM-R01 B in bom/BOM-R01-B.tsv, with the selected relationship rows |
B-release source acceptance, linked to ECO-017 | Accepted in candidate review INC-STRUCT-01 |
| Mechanical design | DW-R01 A in mechanical/DW-R01-A.pdf, with selected native CAD and export identified in its index |
Original mechanical source approval retained | Accepted in INC-MECH-01 |
| Controller | Bought complete CB-200 A, with ECAD CB-200 A package electronics/ECAD-CB-200-A.zip |
Controller and ECAD source approval retained | Accepted in INC-ELEC-01 |
| Harness | HR-300 B, DW-HR-300 B in harness/DW-HR-300-B.pdf, one per B robot |
ECO-017 and B-release source approval | Accepted in INC-HR-01 for 003–005 |
| Drive hardware | Two DM-100 A per robot, resolved through MT-110 A, BR-120 A and SC-130 A in the retained BOM | Unchanged selected hardware source approvals | Accepted in INC-STRUCT-01 |
| Sensor and chassis | SN-400 A, CH-500 A and their controlled design/source references in parts/selected-source-index.tsv |
Unchanged selected source approvals | Accepted in INC-STRUCT-01 |
| Firmware source | Version 1.2.0, source tag r01-fw-v1.2.0, exact source identity SRC-FW-120 in firmware/source-reference.txt |
Source-release approval SRC-APP-FW-120 | Source identified, with exact installable inclusion still pending |
| Installable firmware | Artefact ART-FW-R01-120-01, file firmware/r01-cb200-a-1.2.0.bin, target CB-200 A |
Source 1.2.0 approval alone does not identify this binary | HOLD-FW-01 pending file identity check and inclusion approval |
| Manufacturing documents | Accepted manufacturing-view and instruction index in manufacturing/document-index.tsv |
Document approvals recorded by their source owners | Accepted scope identified in INC-MFG-01 |
| Evidence and decisions | evidence/reference-index.tsv and decisions/approval-index.tsv identify supporting records and package review |
Each record retains its original decision and scope | References included, with no new execution claimed |
The source BOM remains the quantity authority. It resolves the two-A, three-B gross pilot split and ten screws per robot. The manifest's drive-hardware summary points to those relationships rather than creating an additional purchasing quantity. CB-200 is bought complete, so its ECAD package describes its controlled design reference and creates no extra component order. Robotics BOM template
Identify the firmware file independently of its source label
Keep the installable artefact's identifier, filename, target hardware and retained bytes alongside its source tag or commit. A source reference identifies source state. A compiled binary also depends on the build and packaging that produced it. The file selected for installation needs its own identity and approval scope.
GitHub's release documentation illustrates the distinction. Releases are based on tags and can link to binary files, while generated source archives contain repository content at the tag. This is tooling context for recording separate source and installable identities. It does not establish the approval of any R-01 firmware. GitHub release documentation
At M0, ART-FW-R01-120-01 has an exact candidate identifier and filename, but its retained-file digest and source-to-binary confirmation are pending. The firmware owner must identify the actual file, record its digest from those bytes and provide the build or release provenance that binds it to 1.2.0 and CB-200 A. The release authority then decides whether to include that exact file in MAN-R01-B-C01.
No checksum is invented to fill the table. A real record should calculate it from the retained file and name the algorithm. A filename ending in 1.2.0 is insufficient evidence of the file's contents or approval.
Close the candidate hold through a new recorded decision
HOLD-FW-01 keeps this outgoing candidate package unavailable for build use. The product-data owner records the hold beside the manifest and informs the intended receiver which package is affected. The established B selection remains recoverable through its own accepted source records.
The closure requirements are specific.
- The firmware owner supplies the retained ART-FW-R01-120-01 file and its calculated identity check.
- The source-to-artefact record resolves SRC-FW-120, version 1.2.0 and target CB-200 A.
- The release authority reviews the exact file and records its inclusion decision for 003–005.
- The package owner updates the manifest state and retains the preceding held candidate.
- The receiver acknowledges the accepted package identity and confirms it can recover the listed files.
If those conditions pass, the authority can issue the accepted package and record the new decision. If the binary or its supported target changes, the revised material needs review before inclusion. This example supplies the closure rule and leaves the M0 candidate held. The separate readiness instruction example remains in the pilot-build readiness checklist.
Reconstruct the package from the manifest
Give another engineer only MAN-R01-B-C01 and the archive access path. They should recover the manifest revision, CFG-R01-B, BOM-R01 B and serial range. They should then open the selected drawing and ECAD packages, resolve the detailed BOM selections and identify the exact firmware artefact and its hold.
For an accepted archive, compare file identities with the accepted manifest and follow its approval records. Record a missing file, unresolved link or different digest as a package discrepancy with an owner. The tool ownership and handoff guide assigns the corrective editing path. Assess any proposed use of historical results through the robotics verification-evidence guide.
Robot release manifest questions
Does source approval automatically approve package inclusion?
Source approval establishes its recorded scope. The outgoing package needs a decision that identifies the exact selected content and intended build applicability, especially where a binary or export is produced from that source.
Can one Git tag identify the whole robot?
It can identify its repository state. The robot manifest must also resolve the selected hardware, drawings, electronics, installable artefacts and other controlled records needed for its build scope.
What should a missing firmware digest do?
Record it as unresolved with an owner and closure requirement. In this candidate, the missing identity confirmation and inclusion approval hold the outgoing package.
Does this manifest say what was installed on serial 003?
It records the package selected for its scope. The serial-specific robot build record records installation, exceptions and later changes against that starting point.
Continue the package review
Use the configuration matrix to establish applicability and the readiness checklist to decide which build operations can begin from the accepted package.