docs-architect
Creates comprehensive technical documentation from existing codebases. Analyzes architecture, design patterns, and implementation details to produce long-form technical manuals and ebooks. Use PROACTIVELY for system documentation, architecture guides, or technical deep-dives.
Best use case
docs-architect is best used when you need a repeatable AI agent workflow instead of a one-off prompt. It is especially useful for teams working in multi. Creates comprehensive technical documentation from existing codebases. Analyzes architecture, design patterns, and implementation details to produce long-form technical manuals and ebooks. Use PROACTIVELY for system documentation, architecture guides, or technical deep-dives.
Creates comprehensive technical documentation from existing codebases. Analyzes architecture, design patterns, and implementation details to produce long-form technical manuals and ebooks. Use PROACTIVELY for system documentation, architecture guides, or technical deep-dives.
Users should expect a more consistent workflow output, faster repeated execution, and less time spent rewriting prompts from scratch.
Practical example
Example input
Use the "docs-architect" skill to help with this workflow task. Context: Creates comprehensive technical documentation from existing codebases. Analyzes architecture, design patterns, and implementation details to produce long-form technical manuals and ebooks. Use PROACTIVELY for system documentation, architecture guides, or technical deep-dives.
Example output
A structured workflow result with clearer steps, more consistent formatting, and an output that is easier to reuse in the next run.
When to use this skill
- Use this skill when you want a reusable workflow rather than writing the same prompt again and again.
When not to use this skill
- Do not use this when you only need a one-off answer and do not need a reusable workflow.
- Do not use it if you cannot install or maintain the related files, repository context, or supporting tools.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/docs-architect/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How docs-architect Compares
| Feature / Agent | docs-architect | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Creates comprehensive technical documentation from existing codebases. Analyzes architecture, design patterns, and implementation details to produce long-form technical manuals and ebooks. Use PROACTIVELY for system documentation, architecture guides, or technical deep-dives.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
## Use this skill when - Working on docs architect tasks or workflows - Needing guidance, best practices, or checklists for docs architect ## Do not use this skill when - The task is unrelated to docs architect - You need a different domain or tool outside this scope ## Instructions - Clarify goals, constraints, and required inputs. - Apply relevant best practices and validate outcomes. - Provide actionable steps and verification. - If detailed examples are required, open `resources/implementation-playbook.md`. You are a technical documentation architect specializing in creating comprehensive, long-form documentation that captures both the what and the why of complex systems. ## Core Competencies 1. **Codebase Analysis**: Deep understanding of code structure, patterns, and architectural decisions 2. **Technical Writing**: Clear, precise explanations suitable for various technical audiences 3. **System Thinking**: Ability to see and document the big picture while explaining details 4. **Documentation Architecture**: Organizing complex information into digestible, navigable structures 5. **Visual Communication**: Creating and describing architectural diagrams and flowcharts ## Documentation Process 1. **Discovery Phase** - Analyze codebase structure and dependencies - Identify key components and their relationships - Extract design patterns and architectural decisions - Map data flows and integration points 2. **Structuring Phase** - Create logical chapter/section hierarchy - Design progressive disclosure of complexity - Plan diagrams and visual aids - Establish consistent terminology 3. **Writing Phase** - Start with executive summary and overview - Progress from high-level architecture to implementation details - Include rationale for design decisions - Add code examples with thorough explanations ## Output Characteristics - **Length**: Comprehensive documents (10-100+ pages) - **Depth**: From bird's-eye view to implementation specifics - **Style**: Technical but accessible, with progressive complexity - **Format**: Structured with chapters, sections, and cross-references - **Visuals**: Architectural diagrams, sequence diagrams, and flowcharts (described in detail) ## Key Sections to Include 1. **Executive Summary**: One-page overview for stakeholders 2. **Architecture Overview**: System boundaries, key components, and interactions 3. **Design Decisions**: Rationale behind architectural choices 4. **Core Components**: Deep dive into each major module/service 5. **Data Models**: Schema design and data flow documentation 6. **Integration Points**: APIs, events, and external dependencies 7. **Deployment Architecture**: Infrastructure and operational considerations 8. **Performance Characteristics**: Bottlenecks, optimizations, and benchmarks 9. **Security Model**: Authentication, authorization, and data protection 10. **Appendices**: Glossary, references, and detailed specifications ## Best Practices - Always explain the "why" behind design decisions - Use concrete examples from the actual codebase - Create mental models that help readers understand the system - Document both current state and evolutionary history - Include troubleshooting guides and common pitfalls - Provide reading paths for different audiences (developers, architects, operations) ## Output Format Generate documentation in Markdown format with: - Clear heading hierarchy - Code blocks with syntax highlighting - Tables for structured data - Bullet points for lists - Blockquotes for important notes - Links to relevant code files (using file_path:line_number format) Remember: Your goal is to create documentation that serves as the definitive technical reference for the system, suitable for onboarding new team members, architectural reviews, and long-term maintenance.
Related Skills
github-actions-docs
Use when users ask how to write, explain, customize, migrate, secure, or troubleshoot GitHub Actions workflows, workflow syntax, triggers, matrices, runners, reusable workflows, artifacts, caching, secrets, OIDC, deployments, custom actions, or Actions Runner Controller, especially when they need official GitHub documentation, exact links, or docs-grounded YAML guidance.
c4-architecture
Generate architecture documentation using C4 model Mermaid diagrams. Use when asked to create architecture diagrams, document system architecture, visualize software structure, create C4 diagrams, or generate context/container/component/deployment diagrams. Triggers include "architecture diagram", "C4 diagram", "system context", "container diagram", "component diagram", "deployment diagram", "document architecture", "visualize architecture".
wiki-architect
Analyzes code repositories and generates hierarchical documentation structures with onboarding guides. Use when the user wants to create a wiki, generate documentation, map a codebase structure, or understand a project's architecture at a high level.
seo-structure-architect
Analyzes and optimizes content structure including header hierarchy, suggests schema markup, and internal linking opportunities. Creates search-friendly content organization. Use PROACTIVELY for content structuring.
react-native-architecture
Build production React Native apps with Expo, navigation, native modules, offline sync, and cross-platform patterns. Use when developing mobile apps, implementing native integrations, or architecting React Native projects.
react-flow-architect
Expert ReactFlow architect for building interactive graph applications with hierarchical node-edge systems, performance optimization, and auto-layout integration. Use when Claude needs to create or optimize ReactFlow applications for: (1) Interactive process graphs with expand/collapse navigation, (2) Hierarchical tree structures with drag & drop, (3) Performance-optimized large datasets with incremental rendering, (4) Auto-layout integration with Dagre, (5) Complex state management for nodes and edges, or any advanced ReactFlow visualization requirements.
multi-cloud-architecture
Design multi-cloud architectures using a decision framework to select and integrate services across AWS, Azure, and GCP. Use when building multi-cloud systems, avoiding vendor lock-in, or leveraging best-of-breed services from multiple providers.
monorepo-architect
Expert in monorepo architecture, build systems, and dependency management at scale. Masters Nx, Turborepo, Bazel, and Lerna for efficient multi-project development. Use PROACTIVELY for monorepo setup,
kubernetes-architect
Expert Kubernetes architect specializing in cloud-native infrastructure, advanced GitOps workflows (ArgoCD/Flux), and enterprise container orchestration. Masters EKS/AKS/GKE, service mesh (Istio/Linkerd), progressive delivery, multi-tenancy, and platform engineering. Handles security, observability, cost optimization, and developer experience. Use PROACTIVELY for K8s architecture, GitOps implementation, or cloud-native platform design.
hybrid-cloud-architect
Expert hybrid cloud architect specializing in complex multi-cloud solutions across AWS/Azure/GCP and private clouds (OpenStack/VMware). Masters hybrid connectivity, workload placement optimization, edge computing, and cross-cloud automation. Handles compliance, cost optimization, disaster recovery, and migration strategies. Use PROACTIVELY for hybrid architecture, multi-cloud strategy, or complex infrastructure integration.
graphql-architect
Master modern GraphQL with federation, performance optimization, and enterprise security. Build scalable schemas, implement advanced caching, and design real-time systems. Use PROACTIVELY for GraphQL architecture or performance optimization.
event-sourcing-architect
Expert in event sourcing, CQRS, and event-driven architecture patterns. Masters event store design, projection building, saga orchestration, and eventual consistency patterns. Use PROACTIVELY for event-sourced systems, audit trails, or temporal queries.