Documentation Index
Fetch the complete documentation index at: https://docs.roboticks.io/llms.txt
Use this file to discover all available pages before exploring further.
Internal QA Release Gate
Not every product ships into a regulated market. But every shipped product carries product-liability exposure, customer-quality expectations, and an organisational interest in shipping things that work. This pattern uses Roboticks as an internal QA release gate — without any external notified-body involvement — to enforce a defensible, repeatable release discipline. The pattern is also a useful starting point for organisations that intend to pursue external certification later. The artefacts produced here are exactly the artefacts the external pattern needs; adopting them now means certification adds process around evidence you already have, rather than retroactively assembling it.Scenario
You ship a robotics product. There is no external conformity-assessment regime you must satisfy today — perhaps your jurisdiction does not require it, perhaps your product class is exempt, perhaps your customers do not demand it. But:- Your customers have quality expectations.
- Your organisation carries product-liability exposure.
- Engineering wants a stop-the-line discipline rather than firefighting every regression in the field.
- Leadership wants a posture dashboard that says “today, are we shippable.”
Project setup
Create the project
rbtk project create. Use the same project structure you would use for a certification pattern; the discipline is independent of whether you certify.Pin the standards that matter to your engineering
Even without certification, pinning the relevant standards (
industrial-robot-eu, cobot-eu, amr-eu templates) gives you derivation anchors and the publication feed. The first standard subscription is included on Team; the rest are $99 / standard / month — usually worth it for the alerter alone.Or pin nothing — you can author requirements without standards derivation. The traceability still works.Author requirements
Cover your internal “definition of shippable” — every safety-critical behaviour, every performance specification, every customer-facing functional promise. The structure is the same as the industrial-robot pattern; the source is your engineering judgement rather than a standard clause.
The posture dashboard
The release-readiness view is the daily artefact for engineering leadership and QA:- Coverage: of pinned requirements, how many have at least one passing confirming test.
- Gaps: requirements with no confirming test, or confirming tests that fail.
- Acknowledged gaps: requirements with documented rationale for not having coverage (e.g., feature deferred to next release).
- Regression streak: how many days since the last test that was passing has failed.
- Pinned standards: any open amendments not triaged.
The release-state machine
Even without external certification, use the Release state machine:| State | Internal meaning |
|---|---|
draft | Commits pinned; verification not yet run |
verifying | Tests running |
verified | All required tests pass; ready for sign-off |
shipped | Sign-off complete; release deployed to customers |
archived | Beyond active support |
Sign-off workflow
Recommended sign-off configuration:draft→verifying: any engineer with project write access.verifying→verified: automatic on full test pass; manual if you allow acknowledged gaps.verified→shipped: required sign-off from engineering lead and QA lead. Optional: PM or compliance.
Evidence retention for product liability
You may not be filing technical files with notified bodies, but you do carry product-liability exposure. Many jurisdictions impose a 10-year (or longer) product-liability tail. The evidence-pack archive lifecycle (Archive) gives you that retention automatically:- 90 days hot.
- Then 10 years (or your configured floor, up to 25) in S3 Glacier Deep Archive.
- Verifiable years later via the hash chain.
Without standards pinning
If you have no use for standards subscriptions, the pattern still works:- Author requirements with
derives_from: []. They live in Roboticks but reference no external clause. - Generate evidence packs the same way; the pack omits the “standards conformance” section.
- The hash chain, retention, traceability matrix, and posture dashboard all function normally.
When to graduate to external certification
Common triggers for moving from this pattern to an external-certification pattern:- A target market begins regulating your product class (e.g., EU MR 2023/1230 application date arrives).
- A major customer requires conformity declarations.
- Insurance pricing makes certification cost-effective.
- A field incident triggers a review that recommends certification.
Maintenance
| Cadence | Activity |
|---|---|
| Per PR | Change-impact analysis on every PR |
| Per release | Cut release; verify; sign off; ship; mark shipped |
| Weekly | Posture-dashboard review with engineering and QA leads |
| Per standard amendment (if pinned) | Re-conformity workflow — even internally, the trigger and the workflow are the same |
| Per field incident | Generate ad-hoc pack at the field-build commit; investigate; add scenarios |
Next steps
Change-impact workflow
Per-PR triage.
Traceability audit prep
Pre-audit (or pre-release) hygiene check.
Evidence pack archive
The 10-year retention model your product-liability tail needs.
External certification
Patterns to graduate into.