Project Charter PDF Template Generation and Governance SOP

Standard Operating Procedure: Project Charter Template Generation and Governance

Document ID: SOP-TR-ENG-402
Effective Date: October 24, 2023
Version: 3.2.1
Review Cadence: Annual
Owner: Julian Vance, Chief Architect, Template Registry

---

1. Executive Summary & Purpose

This Standard Operating Procedure (SOP) defines the institutional engineering standard for drafting, validating, rendering, and distributing official Project Charter Template PDFs across the Template Registry ecosystem. The objective is to eliminate structural drift, enforce rigorous metadata compliance, and ensure downstream programmatic and manual parsers can ingest, compile, and archive project charters without human intervention or layout degradation.

---

2. Scope & Prerequisites

Scope

This procedure applies to all systems engineers, technical writers, and release managers tasked with updating, compiling, or issuing the master Project_Charter_v3.pdf artifact.

Prerequisites

• Access Control: Write access to the template-registry/core-specs repository and root publishing bucket (s3://tr-artifacts-prod).
• Software Toolchain:
  • Typst v0.11.0+ (Primary document compilation engine)
  • Pandoc v3.1+ (Markdown-to-intermediate translation, if applicable)
  • Python 3.11+ with pypdf and jsonschema validation libraries
  • Git CLI configured with SSH signing keys
• PPE (Personal Protective Equipment): Not applicable (Digital Engineering Asset).

---

3. Roles & Responsibilities (RACI Matrix)

(Legend: Responsible, Accountable, Consulted, Informed)

---

4. Step-by-Step Procedure

Phase 1: Environment Setup and Schema Validation

• Clone the repository and check out a dedicated feature branch:
  git checkout -b feature/charter-update-v3.3
• Verify local Typst installation:
  typst --version (must output >= 0.11.0)
• Run the JSON schema validator against the charter metadata block to ensure strict compliance:
  python3 -m jsonschema -i schemas/charter_meta.json data/default_context.json

Phase 2: Content Compilation & Rendering

• Navigate to the document source directory:
  cd templates/project-charter/
• Compile the Typst source into the target PDF artifact with strict font embedding:
  typst compile --font-path ./assets/fonts source/charter_master.typ build/Project_Charter_v3.pdf
• Verify output visual fidelity against the baseline reference image hashes:
  python3 scripts/verify_render.py --baseline assets/baseline_hash.json --target build/Project_Charter_v3.pdf

Phase 3: Automated Quality Gate & Artifact Signing

• Execute automated structural validation tests to ensure form fields and interactive elements are preserved:
  pytest tests/test_charter_pdf.py
• Cryptographically sign the finalized PDF artifact for immutable provenance tracking:
  gpg --detach-sign --armor build/Project_Charter_v3.pdf
• Upload the signed binary and corresponding checksums to the staging registry.

---

5. Quality Assurance & Pro-Tips

Best Practices

• Never modify raw output PDFs manually: Always modify the underlying Typst source code (.typ) or schema definitions (.json). Manual edits introduce layout corruption and invalidate downstream digital signatures.
• Font Management: Always embed custom vector fonts (Inter, JetBrains Mono) directly via Typst parameters to prevent missing glyph substitution on legacy enterprise PDF viewers.

Common Pitfalls

• Pagination Overflow: Adding more than 3 bullet points per subsection in Section 2 (Objectives) will push the authorization matrix onto page 2. Always run typst query layout diagnostics before finalizing.
• Unescaped Special Characters: Unescaped % or # characters in markdown strings will cause silent compilation failures in the Typst preprocessor.

Metric Thresholds

• Max File Size: $\le 1.2\text{ MB}$ uncompressed.
• Compilation Time: $\le 800\text{ ms}$ on standard CI runners.
• Accessibility: Must achieve 100% pass rate on Adobe Acrobat Pro Accessibility Checker (ISO 14289-1 / PDF/UA compliant).

---

6. Frequently Asked Questions (FAQ)

Q: The compilation fails with a FontNotFound error in the CI pipeline, but it works locally. How do I fix this?
A: The CI runner lacks access to your local system fonts. Ensure the font path is explicitly defined relative to the repository root and that all required TTF/OTF files are committed to templates/project-charter/assets/fonts/.

Q: How do I add a new signature block for secondary stakeholders without breaking the grid system?
A: Modify the grid() layout matrix in source/charter_master.typ. Do not use hardcoded spaces or line breaks. Ensure column widths use proportional sizing (e.g., fr(1)) to maintain responsiveness across A4 and Letter paper formats.