Skip to content

ros-2/compliance-workflow-spec

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 

Repository files navigation

The Quickler Format for Field Compliance Reports

Version 0.1, April 2026 Maintained by: Quickler Ltd, Scotland Contact: philip@quickler.co License: CC-BY-4.0 Canonical URL: https://quickler.co/pages/quickler-format-spec.html

An open specification for how a UK field compliance check should be recorded over messaging, and how the resulting report should be structured.

Built so that:

  • Engineers do not need to install or learn an app
  • Office managers receive a consistent, machine-readable record
  • Building control officers, insurers and certifying bodies can read the report without a vendor-specific viewer
  • Any vendor can implement it; clients are not locked in

This document is a working draft. Comments and pull requests are welcome.

Scope

The format covers three things:

  1. The check definition: what the engineer is asked
  2. The capture conversation: how the engineer responds
  3. The report artefact: the PDF or JSON the office and third parties receive

It does not cover scheduling, pricing or how engineers are dispatched; those are the vendor's problem.

1. Check definition

A check is a JSON object describing one repeated process. Example:

{
  "id": "weekly-van-check-2026-04",
  "name": "Weekly van check",
  "owner": {
    "firm": "Example Trades Ltd",
    "firm_id": "GB-CH-12345678"
  },
  "fields": [
    { "key": "tyres",        "label": "Tyres OK?",        "type": "boolean", "required": true },
    { "key": "lights",       "label": "Lights working?",  "type": "boolean", "required": true },
    { "key": "fluid_levels", "label": "Fluid levels OK?", "type": "boolean", "required": true },
    { "key": "odometer",     "label": "Odometer photo",   "type": "photo",   "required": true },
    { "key": "fault_notes",  "label": "Any fault?",       "type": "text",    "required": false }
  ]
}

Field types

  • text: free text
  • boolean: yes / no
  • number: numeric (whole or decimal)
  • photo: one or more JPEG/HEIC images
  • voice: one audio clip; transcribed automatically
  • signature: captured as an SVG path or PNG

2. Capture conversation

The engineer is messaged via WhatsApp (or any other compliant transport). The system asks one question per field, in order. The engineer replies in any combination of text, photo, voice. The system parses the reply into the typed value.

Compliant implementations MUST:

  • Allow the engineer to skip non-required fields with a single reply (e.g. "skip" or "n/a")
  • Allow the engineer to correct a previous answer at any time before finalisation, by sending the field name and a new value
  • Respect WhatsApp's 24-hour session window; pre-approve a Meta Business template for any conversation that may span longer

3. Report artefact

Each completed check produces a PDF report rendered from a deterministic template, containing:

  • Firm name, registration number, branding
  • Engineer name, mobile number (E.164), date and time of completion
  • Each field's label, value and any attached media (rendered inline)

The specification reserves space for two additional features that are not required in v0.1 implementations and are not yet present in the reference implementation:

  • A SHA-256 hash of the underlying JSON record, printed in the report footer (intended to make the report tamper-evident).
  • A JSON sidecar with the raw structured record, embedded in the PDF as an attachment per ISO 32000-1 §7.11.

Both are tracked as open questions for v0.2.

Compliance levels

A vendor can claim:

  • Quickler-Format Capture: supports section 1 and section 2
  • Quickler-Format Reporting: supports section 3
  • Quickler-Format Full: supports all three

Reference implementation

A reference implementation is maintained by Quickler Ltd. To request access or discuss commercial use of the Quickler-Format mark, email philip@quickler.co.

Conformance declarations

Vendors implementing the format are listed here once a declaration is filed:

  • None yet; be the first.

Open questions for v0.2

  • Schema for non-photo evidence (CAD files, IFC models)
  • Multi-engineer sign-off (one capture, two engineers attesting)
  • Localisation beyond English (Welsh, Gaelic, Polish, common UK trades languages)

Contributing

Pull requests welcome. For substantive changes, open an issue first so the direction can be discussed. Editorial fixes (typos, clearer wording, broken links) can go straight to a PR.

Citing

Quickler Ltd (2026). The Quickler Format for Field Compliance Reports. Version 0.1. https://github.com/ros-2/compliance-workflow-spec


© 2026 Quickler Ltd. Spec released under CC-BY-4.0. Forks and derivative formats welcome; please cite the source.

About

Open specification for UK field compliance reports captured over messaging. The Quickler Format v0.1. CC-BY-4.0.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors