Docs

Templates & Reports

Document templates and reports for professional operational documentation.

WorkCheats supports templates and reports for structuring professional documentation — assessment summaries, incident notes, and repeatable report layouts.

These features help you organise content for authorised security work. They do not replace your organisation's formal reporting or sign-off processes.

Templates vs reports

ConceptWhat it is
TemplateReusable report structure for your workspace — Markdown layout, field definitions, and placeholders for operational writeups
ReportA deliverable document instance — often started from a template snapshot, filled with your notes, field values, and evidence

Creating a report from a template snapshots the template at that moment. Later edits to the template do not change existing reports.

Both use Markdown source editing in the web app today. WorkCheats stores and renders content as text — it does not execute commands referenced in templates or reports.

Templates overview

A template defines the structure you reuse across engagements — headings, placeholders, and field presets for consistent writeups.

  1. Open Templates from your workspace sidebar.
  2. Browse or create templates with Markdown body and field definitions.
  3. Use an active template as the starting point for a new report.

See Templates lifecycle for active vs archived behaviour, provenance, and export rules.

Screenshot placeholder: Templates list showing template names and field counts.

Reports overview

A report holds your written findings, metadata status, structured fields, and evidence references.

  1. Open Reports from the sidebar.
  2. Create a report from an active template or a blank starting point.
  3. Fill in sections, fields, and evidence with your operational notes.

See Reports lifecycle for status labels, provenance, export options, and archive behaviour.

Screenshot placeholder: Report editor showing section headings and text fields.

Session evidence (partial, manual)

When a workflow session is linked to a report, you can send step output notes and attachment metadata into the linked report using Use in report. This is a manual evidence flow — you choose what to send. It does not auto-generate a full report from session outputs.

See Sessions for notes, outputs, and linking behaviour.

Current

  • Create and edit templates (Markdown source) and reports in the web app
  • Create reports from active templates with snapshotted structure
  • Report metadata statuses: Draft, Review, Final (manual labels — not an approval gate)
  • Soft-archive templates and reports; archived items hidden from active lists
  • Report export: JSON manifest, raw Markdown, and PDF (active reports only)
  • Template export: JSON, Markdown, and WorkCheats Package where policy allows (active templates only)
  • Manual Use in report evidence from linked workflow sessions

Current limitations

Be honest about what is available today:

  • Editing is Markdown-first — structured fields and preview, not a full word processor.
  • There is no WYSIWYG rich editor or draw.io integration in the product UI.
  • There is no automatic report generation that assembles a complete draft from session outputs or tool runs.
  • Use in report sends selected note text and/or attachment metadata to a linked report — it does not map all session outputs into report fields automatically.
  • Export eligibility may be restricted by provenance (for example, some Marketplace-installed lineage). See Import & Export for package trust boundaries.

Roadmap

The following are not available yet:

  • Automatic report assembly — full draft generation from session notes and structured outputs
  • WYSIWYG editor — rich HTML formatting for report and template bodies
  • Output-to-placeholder pipelines — automatic mapping of all session step outputs into report fields

Do not plan operational processes around roadmap items until they ship.