Skip to content

Add a New Content Type

Controlled process for expanding documentation formats without breaking existing workflows.

When to add a new content type

  • A recurring authoring need does not fit any existing template (e.g., case-study, incident-report, release-notes).
  • An ad-hoc artifact has been produced > 3 times in different shapes and would benefit from a normalized template.

Steps

  1. Define the type. A short proposal:
  2. identifier (<lowercase-hyphen>),
  3. audience and intent,
  4. sections required,
  5. quality checklist additions if any.

  6. Update the schema.

  7. Bump content-type.schema.json minor version.
  8. Add the new identifier to allowed content_type values (if enumerated).

  9. Create the template.

  10. File: templates/<identifier>.template.md.
  11. Frontmatter conforms to content-type.schema.json.
  12. Required sections present; placeholders explicit.

  13. Editorial guidance.

  14. Append a "Review requirements by content type" row in editorial-policy.md.

  15. Compatibility tests.

  16. Render one document of the new type from a real project source via the doc-generation loop.
  17. Confirm:

    • schema validation passes,
    • editorial policy checks pass,
    • publish-loop dry-run succeeds against at least one applicable adapter (or skip if no adapter applies yet).
  18. Publishing-policy update.

  19. If the new type maps to a new venue category, update publishing-policy.yaml approvals_required.

  20. Document and announce.

  21. Add a row to README.md "Files" table.
  22. Add a row to the add-new-content-type runbook history below.

Audit and version

  • Treat the schema change as policy-change-controlled (SPB-15 spirit).
  • Record in repo history: schema version bump + linked PR.

Rollback

  • If the new type causes lint or workflow regressions, revert the schema version and template, and reissue a smaller, more focused proposal.

History

Date Identifier Reason