technical-docs

Generate technical documentation and Mermaid diagrams with YAML frontmatter-driven discovery.

Updated Aug 23, 2026

Search Tags:#documentation #mermaid #ADR #runbooks #documentation-as-code #doc coverage #diagram-as-code

Ready to run

npx skills add https://github.com/junevm/avtoolz --skill technical-docs-junevm

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: technical-docs
Source: https://github.com/junevm/avtoolz/tree/main/.agents/skills/technical-docs
Command: npx skills add https://github.com/junevm/avtoolz --skill technical-docs-junevm

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill solves the problem of documentation drift by helping you write, audit, and visualize technical documentation directly alongside code changes.

Core Features & Use Cases

Documentation-as-code authoring: Produce consistent technical docs, style guides, and runbooks with CI-friendly structure.
Diagram-as-code generation with Mermaid: Draft flowcharts, ERDs, sequence diagrams, and gitGraph visuals from architecture/code context.
Doc coverage and sync audits: Identify undocumented exports, feature gaps, and outdated defaults via diffs and structured checks.
AI-assisted drafting with guardrails: Use AI to draft while enforcing human verification for correctness and link/snippet validity.

Quick Start

Use the technical-docs skill to audit your latest changes and generate Mermaid ERD and sequence diagrams that match the current codebase.

Frequently Asked Questions about technical-docs

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

FAQPage Schema

How do I keep technical documentation synchronized with code changes?▼

Documentation-as-code practices keep technical documentation synchronized with code changes by running audit workflows that detect undocumented exports and outdated defaults via diffs. This approach treats docs as code, ensuring they remain accurate through CI-friendly structured checks.

How do I generate Mermaid diagrams from existing architecture context?▼

Diagram-as-code generation drafts Mermaid flowcharts, ERDs, sequence diagrams, and gitGraph visuals directly from architecture or code context. This process translates existing structural data into visual representations without manual drawing.

What is documentation coverage gap analysis and when do I need it?▼

Documentation coverage gap analysis identifies undocumented exports, feature gaps, and outdated defaults within software projects. You need this process when documentation drift occurs, ensuring technical docs accurately reflect the current codebase state.

Can I use YAML frontmatter for documentation discovery in CI pipelines?▼

YAML frontmatter-driven discovery supports documentation-as-code practices by providing structured metadata for automated retrieval. This enables CI-friendly structures to locate and process technical documentation, runbooks, and style guides deterministically.

Does AI-assisted drafting work for ADR drafting and runbooks?▼

AI-assisted drafting applies to ADR drafting, runbooks, and style guides while enforcing human verification for correctness. This workflow includes guardrails to validate link and snippet validity, ensuring generated technical documentation remains accurate.

What is the best way to structure technical documentation for CI-friendly workflows?▼

Structuring technical documentation as code with CI-friendly formats enables automated audit workflows and documentation coverage gap analysis. This approach supports deterministic review steps, YAML frontmatter discovery, and consistent style guide enforcement.