How to Onboard a DocGen Solution

Last verified: 2026-07-26 against current checkout c09254f.

Use this guide when adding a new organization/client solution to DocGen.

Inputs

• Organization slug and display name.
• The document deliverable and whether it is truly a document-in-a-template.
• Source systems or files needed for the gather phase.
• Template structure, sections, fields, render modes, and examples.
• Required tools/MCP servers and credentials.
• Demo, UAT, or production deployment target.

Procedure

1. Confirm product fit.

Use the discriminator from Solutions: if the deliverable is a document in a template, DocGen is likely a fit. If the deliverable is primarily a classification/comparison grid, it is likely not a DocGen fit.

1. Create solution documentation.

Add a folder under docs/solutions/<org-or-solution>/. Use a README for lightweight solutions; add PRD/TDD when the solution needs a durable product and technical record.

1. Author the template spec.

Add JSON specs under docgen/src/docgen/authoring/specs/. Use Authoring and config API to validate and apply the spec through /v1.

1. Wire org seeding.

Update the org/spec mapping described in Seeding and platform tools.

1. Wire data sources.

Use built-in tools where possible. For MCP-backed sources, follow MCP transport and library enforcement and MCP per-user auth.

1. Verify generation.

Generate at least one representative instance, inspect sources, review section output, and export the document.

1. Document status.

Update Solutions and the solution folder with status, template spec names, source assumptions, and validation notes.

Verification

• The solution appears in the org/demo selector where expected.
• The spec dry-run succeeds.
• The spec apply path is idempotent or the write behavior is documented.
• A generated instance produces expected sections.
• Sources are visible where the template claims traceability.
• Required credentials are in environment/vault, not committed specs.