Authoring Process

Governed documentation.

This site is a technical writing portfolio built with the same discipline as the products it documents. Content is versioned, vocabulary-controlled, and reviewed before publication — not pasted from chat logs.

Workflow

From source to published doc.

  1. Source binding — Every reference-layout doc declares what it is bound to: docket numbers, product versions, spec revisions. Claims without a binding are flagged, not shipped.
  2. AI-assisted drafting — Models propose structure and prose; they do not publish. Drafts run under governed review with explicit scope for what AI may and may not assert.
  3. SME review — Regulatory facts, architecture claims, and API contracts are verified against source repos and dockets before merge. Review notes live in authoring trails where applicable.
  4. Vocabulary pass — Terms checked against CONTENT-VOCABULARY.md in the repository: status labels, Law counts, canonical URLs, jurisdiction tags.
  5. Layout tier selection — Reader for long-form papers, Reference for product docs, web overview for marketing/architecture landing pages. See presentation tiers below.
  6. Build & publish — Astro static build; markdown and `.astro` pages in git. No CMS, no orphan PDFs — print uses browser print with shared CSS.
Presentation tiers

Three doc genres on this site.

Reference doc
Forge layout

Dark forge palette, sidebar TOC, source binding blocks, authoring trails. Used for product architecture, API refs, compliance scenarios.

e.g. Part 108 · Light Station · Vigil API
Reader
Warm paper layout

Light paper pane on dark surround. Position papers and constitutional specs meant to be read cover-to-cover.

e.g. Agency Paradox · AgentVector Codex
Web overview
Marketing / architecture pages

Sectioned landing pages with cards and diagrams — not downloadable specs. Entry points before deep docs.

e.g. /agentvector · /apps index
Docs-as-code

Repository conventions.

Content lives in src/pages/ as Astro pages and markdown with frontmatter. Shared components (ReferenceLayout, ReaderLayout, SourceBinding, AuthoringTrail) enforce consistent structure.

Controlled vocabulary is maintained in CONTENT-VOCABULARY.md at repo root — status terms, Law counts, canonical URLs, and stack labels. Portfolio index at /portfolio tiers featured samples separately from the full catalog.

Writing portfolio Featured samples with context blocks Governed doc example Architecture overview with authoring trail
Contact

Technical writing roles.

For hiring inquiries or writing samples beyond what is published here, email stephen@macsweeney.llc. For framework or consulting work, see macsweeney.llc ↗.

Email for roles → View portfolio →