Дом

Skill

Документация

codebase-onboarding

alirezarezvani/claude-skills

Проводить анализ кодовой базы и создавать вводную документацию для инженеров, технических руководителей и подрядчиков, обеспечивая быстрый сбор информации и получение стандартизированных результатов.

...Расширить все

Обновлено время 30 августа 2026 г.

# documentation # onboarding # architecture discovery # codebase analysis # developer experience

Введение в кодовую базу

Уровень: POWERFUL
Категория: Инжиниринг
Область: Документация / Опыт разработчика

Обзор

Анализирует кодовую базу и генерирует документацию по введению в курс дела для инженеров, технических руководителей и подрядчиков. Данный навык оптимизирован для быстрого сбора фактов и получения повторяемых результатов при введении в курс дела.

Основные возможности

Выявление архитектуры и стека на основе сигналов из репозиториев
Перечень ключевых файлов и конфигураций для новых участников проекта
Настройка локальной среды и генерация инструкций по выполнению типовых задач
Структурирование документации с учетом целевой аудитории
Создание шаблонов чек-листов для отладки и участия в проекте

Когда использовать

При приёме на работу нового члена команды или подрядчика
Обновление устаревшей проектной документации после масштабной рефакторизации
При подготовке внутренней документации по передаче дел
Создание стандартизированного пакета материалов для введения в курс дела для отделов

Быстрый старт

# 1) Сбор данных о кодовой базе
python3 scripts/codebase_analyzer.py /path/to/repo

# 2) Экспорт результатов в машиночитаемом формате
python3 scripts/codebase_analyzer.py /path/to/repo --json

# 3) Использование шаблона для составления чернового варианта документации по адаптации новых сотрудников
# См. references/onboarding-template.md

Шаблон документа по введению в курс дела

Подробный шаблон и примеры разделов находятся в:

references/onboarding-template.md
references/output-format-templates.md

Распространенные ошибки

Написание документации без проверки команд настройки в «чистой» среде
Включение подробных описаний архитектуры в документацию, предназначенную для подрядчиков
Пропуск шагов по устранению неполадок и проверке
Несоответствие документации по адаптации новых сотрудников текущему состоянию репозитория

Рекомендации

Сделайте инструкции по настройке выполнимыми и ограниченными по времени.
Обосновывайте «почему» ключевые архитектурные решения.
Обновляйте документацию в том же PR, что и изменения в поведении.
Рассматривайте документацию по адаптации новых сотрудников как живой операционный ресурс, а не как разовый результат работы.

Посмотреть на GitHub

---
name: codebase-onboarding
description: Analyze a codebase and generate onboarding documentation for engineers, tech leads, and contractors, with fast fact-gathering and repeatable outputs.
---

# Codebase Onboarding

**Tier:** POWERFUL  
**Category:** Engineering  
**Domain:** Documentation / Developer Experience

---

## Overview

Analyze a codebase and generate onboarding documentation for engineers, tech leads, and contractors. This skill is optimized for fast fact-gathering and repeatable onboarding outputs.

## Core Capabilities

- Architecture and stack discovery from repository signals
- Key file and config inventory for new contributors
- Local setup and common-task guidance generation
- Audience-aware documentation framing
- Debugging and contribution checklist scaffolding

---

## When to Use

- Onboarding a new team member or contractor
- Rebuilding stale project docs after large refactors
- Preparing internal handoff documentation
- Creating a standardized onboarding packet for services

---

## Quick Start

```bash
# 1) Gather codebase facts
python3 scripts/codebase_analyzer.py /path/to/repo

# 2) Export machine-readable output
python3 scripts/codebase_analyzer.py /path/to/repo --json

# 3) Use the template to draft onboarding docs
# See references/onboarding-template.md
```

---

## Recommended Workflow

1. Run `scripts/codebase_analyzer.py` against the target repository.
2. Capture key signals: file counts, detected languages, config files, top-level structure.
3. Fill the onboarding template in `references/onboarding-template.md`.
4. Tailor output depth by audience:
   - Junior: setup + guardrails
   - Senior: architecture + operational concerns
   - Contractor: scoped ownership + integration boundaries

---

## Onboarding Document Template

Detailed template and section examples live in:
- `references/onboarding-template.md`
- `references/output-format-templates.md`

---

## Common Pitfalls

- Writing docs without validating setup commands on a clean environment
- Mixing architecture deep-dives into contractor-oriented docs
- Omitting troubleshooting and verification steps
- Letting onboarding docs drift from current repo state

## Best Practices

1. Keep setup instructions executable and time-bounded.
2. Document the "why" for key architectural decisions.
3. Update docs in the same PR as behavior changes.
4. Treat onboarding docs as living operational assets, not one-time deliverables.

Все файлы

0 файлов

Установить codebase-onboarding

Скачайте файлы навыков и распакуйте их в каталог .claude/skills/.

Скачать ZIP

Клонируйте репозиторий и скопируйте файлы навыка в свой проект.

git clone https://github.com/alirezarezvani/claude-skills/tree/main/engineering/skills/codebase-onboarding # Copy SKILL.md to your .claude/skills/ directory