tech-docs

Document technical documentation standards for mono-repo and single-repo projects.

10|2|Updated Mar 3, 2026
One-click install
npx skills add https://github.com/thermiteau/maverick --skill tech-docs-thermiteau
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: tech-docs
Source: https://github.com/thermiteau/maverick/tree/main/skills/tech-docs
Command: npx skills add https://github.com/thermiteau/maverick --skill tech-docs-thermiteau

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Technical documentation standards streamline consistency across teams, ensuring that system descriptions, interactions, and rationale are expressed plainly for machine consumption and onboarding.

Core Features & Use Cases

  • Structured frontmatter guidance: defines required fields, sections, and references to related docs to enable predictable loading in LLM contexts.
  • Diagram and accessibility guidance: mandates Mermaid diagrams for interactions and focuses on ARIA considerations where applicable, improving accessibility and comprehension.
  • Documentation governance: outlines inclusion/exclusion rules, table-based APIs, and validation patterns to enforce quality across projects.
  • Use Case: an engineering team uses tech-docs to generate consistent architecture overviews and decision records for a large mono-repo.

Quick Start

Create a minimal technical documentation document that begins with a YAML frontmatter and includes an overview and integration points.

Frequently Asked Questions about tech-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I standardize technical documentation structure for a mono-repo?

Technical documentation standards require mandatory YAML frontmatter fields and defined sectioning rules to enable predictable loading in LLM contexts. This structure streamlines system descriptions and onboarding consistency across teams.

What is the best way to include architecture diagrams in technical docs for LLM consumption?

Mermaid diagrams are mandated for illustrating system interactions within technical documentation. This visual standard improves accessibility and comprehension while satisfying validation patterns for machine consumption.

Does this technical documentation standard work for both mono-repo and single-repo projects?

Yes, this technical documentation standard applies to both mono-repo and single-repo projects. It governs inclusion rules and table-based APIs to enforce documentation quality regardless of repository architecture.

Why avoid code blocks and CLI commands in architecture documentation?

Technical documentation avoids code blocks and CLI commands to focus on high-level system interactions, rationale, and accessibility. This governance rule ensures docs remain clear for onboarding and machine consumption.