docs-architect — скилл для Claude Code: документация и установка
Скилл docs-architect для Claude Code разбирает архитектуру и устройство кодовой базы, чтобы подготовить подробную техническую документацию. Включается для создания руководств, описания компонентов и объяснения проектных решений.
MIT 2 установок ★ 50 109 обновлён 2026-10-29
npx skills add sickn33/agentic-awesome-skills --skill docs-architect -a claude-codeЧто делает docs-architect
Скилл анализирует структуру проекта, связи между компонентами, потоки данных и точки интеграции. На этой основе он составляет документацию с разделами об архитектуре, ключевых модулях, моделях данных, развёртывании и безопасности.
Результат оформляется в Markdown: с иерархией заголовков, примерами кода, таблицами и ссылками на файлы проекта. Скилл также предлагает описывать диаграммы и добавлять пояснения к решениям, опираясь на код, комментарии или подтверждённый контекст; причины, которые приходится выводить косвенно, следует помечать как предположения.
Какие задачи решает
- описать архитектуру существующей кодовой базы
- объяснить связи между модулями и потоки данных
- собрать техническое руководство по проекту
- зафиксировать причины архитектурных решений
Примеры запросов агенту
- Подготовь техническую документацию по архитектуре этой кодовой базы.
- Опиши основные модули, интеграции и потоки данных проекта.
- Составь руководство для новых разработчиков и укажи, на каких файлах основаны выводы.
Как установить docs-architect
1Через Skills CLI (Vercel)
npx skills add sickn33/agentic-awesome-skills --skill docs-architect -a claude-code2Вручную: положить файлы
~/.claude/skills/docs-architect/SKILL.mdПапка скилла целиком; для одного проекта — .claude/skills/docs-architect/
1Через Skills CLI (Vercel)
npx skills add sickn33/agentic-awesome-skills --skill docs-architect -a codex2Вручную: положить файлы
.agents/skills/docs-architect/SKILL.mdДля всех проектов — ~/.agents/skills/
1Через Skills CLI (Vercel)
npx skills add sickn33/agentic-awesome-skills --skill docs-architect -a cursor2Вручную: положить файлы
.cursor/skills/docs-architect/SKILL.mdCursor читает и .agents/skills/, и .claude/skills/
1GitHub CLI
gh skill install sickn33/agentic-awesome-skills skills/docs-architect2Вручную: положить файлы
.github/skills/docs-architect/SKILL.md1Через Skills CLI (Vercel)
npx skills add sickn33/agentic-awesome-skills --skill docs-architect -a gemini-cli2Командой платформы
gemini skills install https://github.com/sickn33/agentic-awesome-skills --path skills/docs-architectВручную: положить файлы
.devin/skills/docs-architect/SKILL.mdСтарый путь .windsurf/skills/ тоже читается
Через Skills CLI (Vercel)
npx skills add sickn33/agentic-awesome-skills --skill docs-architect -a opencodeClaude.ai
Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills
По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов
Вопросы о docs-architect
Как установить docs-architect в Claude Code?
Выполни npx skills add sickn33/agentic-awesome-skills --skill docs-architect -a claude-code. Файл скилла появится по пути ~/.claude/skills/docs-architect/SKILL.md.
Что делает docs-architect?
Он изучает существующую кодовую базу и создаёт структурированную техническую документацию. В неё могут войти описание архитектуры, компонентов, интеграций и проектных решений.
В каком формате скилл создаёт документацию?
Документация оформляется в Markdown. В ней могут быть заголовки, блоки кода, таблицы, списки и ссылки на файлы проекта.
Исходный текст
SKILL.md · MIT
--- name: docs-architect description: Creates comprehensive technical documentation from existing codebases. Analyzes architecture, design patterns, and implementation details to produce long-form technical manuals and ebooks. risk: safe source: community date_added: '2026-02-27' --- ## 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. 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 - Explain design rationale only when supported by code comments, architecture decisions, issues, or confirmed maintainer context; label inferred rationale and unknown history. Never invent benchmarks or deployment/security guarantees. - 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. ## Example **User request:** > Use @docs-architect for this task: Creates comprehensive technical documentation from existing codebases. ## Limitations - Use this skill only when the task clearly matches the scope described above. - Do not treat the output as a substitute for environment-specific validation, testing, or expert review. - Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.
© sickn33 · MIT · sickn33/agentic-awesome-skills