technical-documentation

Generate structured technical documentation with Mermaid diagrams for software projects.

Updated Aug 23, 2026

Search Tags:#automation #architecture #documentation #mermaid #multi-repo #runbook #technical-writing

Ready to run

npx skills add https://github.com/Great-Gray-Group/devops-skills --skill technical-documentation-great-gray-group

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: technical-documentation
Source: https://github.com/Great-Gray-Group/devops-skills/tree/main/technical-documentation
Command: npx skills add https://github.com/Great-Gray-Group/devops-skills --skill technical-documentation-great-gray-group

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Produce comprehensive, structured technical documentation for software projects—helping teams crystallize architecture, design decisions, and operational procedures in a reusable format.

Core Features & Use Cases

Automatically generate System Architecture Overviews, Deployment Topologies, API references, data models, and runbooks from existing codebases.
Support single-repo documentation workflows or master umbrella docs for multi-repo platforms, including cross-repo diagrams and consistency guidance.
Visualize with Mermaid diagrams (flowcharts, sequence diagrams, ER diagrams, state machines, and architecture graphs) to communicate complex relationships clearly.
Output two formats and publication-ready destinations: a consolidated TECHNICAL_DOCUMENTATION.md in the repo and a central docs folder, plus Confluence publishing when requested.

Quick Start

Provide the project details and run /technical-documentation to generate a complete documentation package.

Frequently Asked Questions about technical-documentation

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

FAQPage Schema

How do I generate technical documentation for a multi-repo software project?▼

You can generate comprehensive technical documentation across single and multi-repo environments by providing project details. It produces a master umbrella document featuring cross-repo diagrams, architecture overviews, and consistency guidance for publication.

What types of technical documentation can I create for my software architecture?▼

You can create technical documentation artifacts covering System Architecture Overviews, Deployment Topologies, Component Interactions, Data Models, API References, CI/CD pipelines, state machines, and Runbooks from your existing codebase.

Can I use Mermaid diagrams to visualize component interactions and data models?▼

Yes, you can use Mermaid diagrams to visualize component interactions and data models. The documentation process generates flowcharts, sequence diagrams, ER diagrams, state machines, and architecture graphs to communicate complex relationships clearly.

Does this documentation workflow support exporting to Confluence?▼

Yes, the documentation workflow supports Confluence. It outputs a consolidated TECHNICAL_DOCUMENTATION.md file in the repository and a central docs folder, plus Confluence publishing when requested.

What is the best way to document deployment topology and CI/CD pipelines?▼

The best way to document deployment topology and CI/CD pipelines is to run an automated documentation command against your codebase, which extracts the configurations and generates structured, publication-ready markdown artifacts.