Documentation portfolio¶

This portfolio shows how I approach documentation as a product: clear information architecture, developer-first writing, docs-as-code workflows, API documentation, and AI-assisted documentation governance.

Recommended project order¶

Use this order when scanning the GitHub profile or reviewing the portfolio:

1. Docs Portfolio - start here for the baseline documentation samples and working style
2. Docs AI Operating Model - flagship AI DocsOps project covering quality gates, PromptOps, governance, and evaluation
3. OpenAPI to Human Reference - API documentation transformation from OpenAPI contract to readable Markdown reference
4. DocsOps Quality Gate - reusable PR quality gate for linting, link checks, terminology, and scorecards

Recommended reading order¶

A short path through the most representative samples in this site:

• Docs strategy - how I plan, govern, and scale documentation
• Mental model - conceptual framing and boundaries
• Send your first event - task flow with explicit prerequisites and success criteria
• Event Intake API reference - reference structure, examples, and edge-case awareness

What's included¶

• Topic-based information architecture with concept, how-to, reference, and troubleshooting patterns
• Developer-first writing with prerequisites, expected results, copy-paste examples, and clear terminology
• API documentation essentials using a minimal OpenAPI source and integration-focused reference presentation
• Docs-as-code foundations with Markdown content designed for review, iteration, and automation-friendly workflows
• Quality controls with style guidance and repeatable conventions for contributor consistency
• AI DocsOps direction through the companion Docs AI Operating Model repository

Next iterations¶

• Findability: tune labels and navigation based on common entry points and real search terms
• Reference depth: expand authentication, rate limits, pagination, idempotency, and error model consistency
• Operational model: define ownership, review cadence, and definition of done per content type
• Feedback loop: add lightweight signals such as helpfulness, support patterns, and doc bug reports to guide continuous improvement