Practical guide

Version the template and its input contract together

Last materially reviewed 2026-10-01

Quick answerMake every released report traceable to the template and data shape used.
What to know

Name the complete release unit

A template file alone is not the whole process. Keep its accepted version together with the input schema, relevant font and asset choices, connector mapping and acceptance cases. Record which version generated a released report where your authorized system supports that record. Do not place secret keys or client data in public version-control examples.

What to know

Use a change note with a reason

A useful note says Changed note box width to preserve long approved paragraphs, with the affected case IDs. It does not merely say improvements. Distinguish a visual correction from a field-meaning change. Both may need review, but a renamed source path can break reports that look unchanged in a blank preview.

What to know

Keep a known accepted version

Before editing, retain the last accepted template and its matching sample inputs. Test changes against short, long, empty and boundary cases. Avoid editing the only live copy while scheduled reports are being generated. A rollback is useful only if the old template and input contract still work together.

What to know

Release deliberately

Record who approved the new version and when it becomes the default. Separate test output from files that may be sent to recipients. If a change fails, return to the accepted version only after checking compatibility; do not silently regenerate and resend previously delivered client reports.

What to know

Worked version record

A useful non-secret release record might say template T-003, schema S-002, cases normal-2 and long-2, change: expanded note area, decision: accepted by the report owner. Keep T-002 with its matching schema and cases rather than only saving a screenshot. If S-002 introduced a required field, rolling back the template alone may not restore a working process. Compatibility must be checked before using the prior version.

Continue when useful

Next: Build the case pack

Write expected outcomes before generating anything, then keep the cases unchanged.

Open Build the case pack →

Sources used for this page

These records support the facts and comparisons above. Merchant-controlled records are labelled so you can separate product claims from independent evidence.

  1. CraftMyPDF: documented template workflow — Merchant documentation · craftmypdf.com · Merchant-controlled · checked 2026-09-30