Программная инженерия
Создайте обзор кодовой базы для нового инженера
Вводный тур для новичка начинается с запускаемого пути, объясняет границы репозитория и владение и назначает постепенные упражнения по чтению кода.
Процесс
Делай в этом порядке.
- Определите роль нового инженера, первый полезный результат, ограничение времени, ревизию репозитория, локальные предпосылки и вопросы, на которые должен ответить тур.
- Проследите безопасный основной путь от точки входа до теста или артефакта, записывая команды, ожидаемый вывод и самое маленькое полезное изменение.
- Составьте карту основных каталогов, границ сборки и развёртывания, систем данных и внешних систем, владельцев, документации и ключевых решений.
- Создайте постепенные остановки с вопросом для чтения, небольшим упражнением, сигналом проверки и ясной остановкой до производства или доступа с последствиями.
- Добавьте глоссарий, ссылки на авторитетный код и решения, типичные ловушки, контакты для эскалации и указания по частным или непубличным доказательствам.
- Проверьте тур с коллегой или самопроверкой из чистой среды, исправьте неясные шаги и запишите то, что проверить не удалось.
- Опубликуйте тур с версией, владельцем обновлений, доказательствами каждого пути, известными ограничениями и нерешёнными рисками для будущих сопровождающих.
Принеси это
Входы, которые кот спросит.
- роль нового инженера и первый результат
- репозиторий и инструкции локальной настройки
- ограничение времени и обучения
- владельцы и контакты для эскалации
Роутер + один playbook
Сначала маршрут. Выбери один.
Cat Paw открывает один playbook на задачу, не смешивает несколько. Начни с этого роутера; остальные пути — кандидаты именно этого workflow.
- Роутер:
codebase-knowledge-pack skills/codebase-knowledge-pack/codebase-onboarding-tour/SKILL.md
Границы
Границы едут вместе с промптом.
- Перед началом проверьте реальные инструменты, учётные записи, разрешения и рабочую область; никогда не утверждайте, что недоступный инструмент, учётная запись, источник или возможность существует.
- Используйте Latch/target-workspace для приватного кода, артефактов, живых проверок или непубличных данных; если доступ недоступен, остановитесь на границе и сообщите о блокировке, не подменяя её догадкой.
- Приостановите работу для явного одобрения перед внешними действиями с последствиями; верните доказательства, нерешённые риски, допущения и любое действие, ожидающее одобрения.
Готово значит
Проверяемый финиш.
Версионированный вводный тур ведёт нового инженера от проверенного запускаемого пути к более глубокому пониманию репозитория, фиксируя владение, упражнения, доказательства и нерешённые риски.
Источники
Откуда взялся этот процесс.
- github.com/Egonex-AI/Understand-Anything/tree/6df3065f1d8ddc2ce3615314d1d493f36d6b1c80/
- c4model.com/
- docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
Источники задают рисунок workflow. Посты Reddit и сообщества, если они есть, — байки практиков, не универсальные факты.
