Where does the skill store the generated documentation?

It follows a standardized organization pattern, storing all files under a `docs/technical/` directory using kebab-case naming and maintaining a central index file.

Does it support visual diagrams?

Yes, it produces professional Mermaid diagrams for service interactions, data flows, architecture overviews, and state transitions to provide visual clarity alongside text.

What makes this documentation skill different from standard tools?

The tech-docs skill specifically writes for 'machine comprehension first.' It uses high-density formatting, avoids prose padding, and employs structured tables and YAML frontmatter to ensure documents are highly efficient when loaded into an LLM's context window.

Does it include implementation code in the documents?

By design, it excludes implementation code, function bodies, and CLI commands to keep the documentation focused on high-level architecture and to maximize token budget for system design.

Technical Documentation Architect

Name: Technical Documentation Architect
Author: thermiteau

bythermiteau

0•

Learning & Documentation

Generates high-density, machine-readable technical documentation and Mermaid diagrams optimized for LLM context windows.

The tech-docs skill empowers Claude to create and maintain structured technical documentation that prioritizes precision and token efficiency over narrative prose. Designed specifically to enhance LLM comprehension during development tasks, it produces professional markdown files complete with YAML frontmatter, architectural design records, and complex Mermaid diagrams for visual flows. By documenting the 'what', 'how', and 'why' of a system through dense tables and bullet points rather than verbose paragraphs, it ensures that your project documentation is both human-readable and perfectly suited for being loaded into AI context windows.

Key Features

01Standardizes documentation for service interactions, data flows, and design decisions.

02Automates the creation of a centralized documentation index for easy navigation.

03Generates LLM-optimized markdown with YAML frontmatter for metadata.

04Creates complex Mermaid diagrams for sequence, flow, and architecture visualization.

05Converts public API surfaces and module exports into token-efficient tables.

060 GitHub stars

Use Cases

01Updating project documentation automatically following major refactors or logic changes.

02Generating architectural overviews for new microservices or complex subsystems.

03Capturing architectural decision records (ADRs) and design rationale in a consistent format.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add thermiteau/maverick-private tech-docs

For use in Claude.ai and ChatGPT

Key Features

01Standardizes documentation for service interactions, data flows, and design decisions.

02Automates the creation of a centralized documentation index for easy navigation.

03Generates LLM-optimized markdown with YAML frontmatter for metadata.

04Creates complex Mermaid diagrams for sequence, flow, and architecture visualization.

05Converts public API surfaces and module exports into token-efficient tables.

060 GitHub stars

Use Cases

01Updating project documentation automatically following major refactors or logic changes.

02Generating architectural overviews for new microservices or complex subsystems.

03Capturing architectural decision records (ADRs) and design rationale in a consistent format.