speccrew 0.1.1 → 0.1.2

package/docs/GETTING-STARTED.ru.md

@@ -0,0 +1,449 @@
+# SpecCrew - Руководство по быстрому запуску
+
+<p align="center">
+  <a href="./GETTING-STARTED.md">简体中文</a> |
+  <a href="./GETTING-STARTED.zh-TW.md">繁體中文</a> |
+  <a href="./GETTING-STARTED.en.md">English</a> |
+  <a href="./GETTING-STARTED.ko.md">한국어</a> |
+  <a href="./GETTING-STARTED.de.md">Deutsch</a> |
+  <a href="./GETTING-STARTED.es.md">Español</a> |
+  <a href="./GETTING-STARTED.fr.md">Français</a> |
+  <a href="./GETTING-STARTED.it.md">Italiano</a> |
+  <a href="./GETTING-STARTED.da.md">Dansk</a> |
+  <a href="./GETTING-STARTED.ja.md">日本語</a> |
+  <a href="./GETTING-STARTED.ar.md">العربية</a> |
+  <a href="./GETTING-STARTED.ru.md">Русский</a>
+</p>
+
+Этот документ поможет вам быстро понять, как использовать команду Агент SpecCrew для завершения полного цикла разработки от требований до доставки в соответствии со стандартными инженерными процессами.
+
+---
+
+## 1. Предварительные требования
+
+### Установка SpecCrew
+
+```bash
+npm install -g speccrew
+```
+
+### Инициализация проекта
+
+```bash
+speccrew init --ide qoder
+```
+
+Поддерживаемые IDE: `qoder`, `cursor`, `claude`, `codex`
+
+### Структура каталогов после инициализации
+
+```
+.
+├── .qoder/
+│   ├── agents/          # Файлы определения Агентов
+│   └── skills/          # Файлы определения Навыков
+├── speccrew-workspace/  # Рабочее пространство
+│   ├── docs/            # Конфигурации, правила, шаблоны, решения
+│   ├── iterations/      # Текущие итерации
+│   ├── iteration-archives/  # Архивированные итерации
+│   └── knowledges/      # База знаний
+│       ├── base/        # Базовая информация (диагностические отчеты, технический долг)
+│       ├── bizs/        # Бизнес-база знаний
+│       └── techs/       # Техническая база знаний
+```
+
+### Справочник команд CLI
+
+| Команда | Описание |
+|---------|-------------|
+| `speccrew list` | Список всех доступных Агентов и Навыков |
+| `speccrew doctor` | Проверка целостности установки |
+| `speccrew update` | Обновление конфигурации проекта до последней версии |
+| `speccrew uninstall` | Удаление SpecCrew |
+
+---
+
+## 2. Обзор рабочего процесса
+
+### Полная диаграмма потока
+
+```mermaid
+flowchart LR
+    PRD[Этап 1<br/>Анализ требований<br/>Product Manager] --> FD[Этап 2<br/>Проектирование функций<br/>Feature Designer]
+    FD --> SD[Этап 3<br/>Проектирование системы<br/>System Designer]
+    SD --> DEV[Этап 4<br/>Разработка<br/>System Developer]
+    DEV --> TEST[Этап 5<br/>Тестирование системы<br/>Test Manager]
+    TEST --> ARCHIVE[Этап 6<br/>Архивирование]
+    
+    KB[(База знаний<br/>На протяжении всего процесса)] -.-> PRD
+    KB -.-> FD
+    KB -.-> SD
+    KB -.-> DEV
+    KB -.-> TEST
+```
+
+### Основные принципы
+
+1. **Зависимости этапов**: Результаты каждого этапа являются входными данными для следующего этапа
+2. **Подтверждение контрольных точек**: Каждый этап имеет точку подтверждения, требующую одобрения пользователя перед переходом к следующему этапу
+3. **Управление базой знаний**: База знаний проходит через весь процесс, предоставляя контекст для всех этапов
+
+---
+
+## 3. Нулевой шаг: Диагностика проекта и инициализация базы знаний
+
+Перед началом формального инженерного процесса необходимо инициализировать базу знаний проекта.
+
+### 3.1 Диагностика проекта
+
+**Пример диалога**:
+```
+@speccrew-team-leader диагностировать проект
+```
+
+**Что сделает Агент**:
+- Сканирование структуры проекта
+- Обнаружение технологического стека
+- Идентификация бизнес-модулей
+
+**Результат**:
+```
+speccrew-workspace/knowledges/base/diagnosis-reports/diagnosis-report-{date}.md
+```
+
+### 3.2 Инициализация технической базы знаний
+
+**Пример диалога**:
+```
+@speccrew-team-leader инициализировать техническую базу знаний
+```
+
+**Трехэтапный процесс**:
+1. Обнаружение платформы — Идентификация технологических платформ в проекте
+2. Генерация технической документации — Создание документов технических спецификаций для каждой платформы
+3. Генерация индекса — Создание индекса базы знаний
+
+**Результат**:
+```
+speccrew-workspace/knowledges/techs/{platform-id}/
+├── tech-stack.md          # Определение технологического стека
+├── architecture.md        # Архитектурные соглашения
+├── dev-spec.md            # Спецификации разработки
+├── test-spec.md           # Спецификации тестирования
+└── INDEX.md               # Файл индекса
+```
+
+### 3.3 Инициализация бизнес-базы знаний
+
+**Пример диалога**:
+```
+@speccrew-team-leader инициализировать бизнес-базу знаний
+```
+
+**Четырехэтапный процесс**:
+1. Инвентаризация функций — Сканирование кода для идентификации всех функциональных возможностей
+2. Анализ функций — Анализ бизнес-логики каждой функции
+3. Сводка по модулям — Суммаризация функций по модулям
+4. Сводка системы — Создание бизнес-обзора на уровне системы
+
+**Результат**:
+```
+speccrew-workspace/knowledges/bizs/
+├── {platform-type}/
+│   └── {module-name}/
+│       └── feature-spec.md
+└── system-overview.md
+```
+
+---
+
+## 4. Руководство по диалогу этап за этапом
+
+### 4.1 Этап 1: Анализ требований (Product Manager)
+
+**Как начать**:
+```
+@speccrew-product-manager у меня новое требование: [опишите ваше требование]
+```
+
+**Рабочий процесс Агента**:
+1. Чтение обзора системы для понимания существующих модулей
+2. Анализ требований пользователя
+3. Генерация структурированного документа PRD
+
+**Результат**:
+```
+iterations/{номер}-{тип}-{имя}/01.product-requirement/
+├── [feature-name]-prd.md           # Документ требований продукта
+└── [feature-name]-bizs-modeling.md # Бизнес-моделирование (для сложных требований)
+```
+
+**Контрольный список подтверждения**:
+- [ ] Описание требования точно отражает намерение пользователя?
+- [ ] Бизнес-правила полны?
+- [ ] Точки интеграции с существующими системами ясны?
+- [ ] Критерии приемки измеримы?
+
+---
+
+### 4.2 Этап 2: Проектирование функций (Feature Designer)
+
+**Как начать**:
+```
+@speccrew-feature-designer начать проектирование функций
+```
+
+**Рабочий процесс Агента**:
+1. Автоматическое обнаружение подтвержденного документа PRD
+2. Загрузка бизнес-базы знаний
+3. Генерация проектирования функций (включая UI-вейрфреймы, потоки взаимодействия, определения данных, API-контракты)
+4. Для нескольких PRD использовать Task Worker для параллельного проектирования
+
+**Результат**:
+```
+iterations/{iter}/02.feature-design/
+└── [feature-name]-feature-spec.md  # Документ проектирования функций
+```
+
+**Контрольный список подтверждения**:
+- [ ] Все пользовательские сценарии покрыты?
+- [ ] Потоки взаимодействия ясны?
+- [ ] Определения полей данных полны?
+- [ ] Обработка исключений всесторонняя?
+
+---
+
+### 4.3 Этап 3: Проектирование системы (System Designer)
+
+**Как начать**:
+```
+@speccrew-system-designer начать проектирование системы
+```
+
+**Рабочий процесс Агента**:
+1. Обнаружение Feature Spec и API Contract
+2. Загрузка технической базы знаний (технологический стек, архитектура, спецификации для каждой платформы)
+3. **Контрольная точка A**: Оценка фреймворка — Анализ технических пробелов, рекомендация новых фреймворков (при необходимости), ожидание подтверждения пользователя
+4. Генерация DESIGN-OVERVIEW.md
+5. Использование Task Worker для параллельной рассылки проектирования для каждой платформы (frontend/backend/мобильный/настольный)
+6. **Контрольная точка B**: Совместное подтверждение — Показ сводки всех дизайнов платформ, ожидание подтверждения пользователя
+
+**Результат**:
+```
+iterations/{iter}/03.system-design/
+├── DESIGN-OVERVIEW.md              # Обзор дизайна
+├── {platform-id}/
+│   ├── INDEX.md                    # Индекс дизайна платформы
+│   └── {module}-design.md          # Проектирование модуля на уровне псевдокода
+```
+
+**Контрольный список подтверждения**:
+- [ ] Псевдокод использует реальный синтаксис фреймворка?
+- [ ] Кросс-платформенные API-контракты согласованы?
+- [ ] Стратегия обработки ошибок унифицирована?
+
+---
+
+### 4.4 Этап 4: Реализация разработки (System Developer)
+
+**Как начать**:
+```
+@speccrew-system-developer начать разработку
+```
+
+**Рабочий процесс Агента**:
+1. Чтение документов проектирования системы
+2. Загрузка технических знаний для каждой платформы
+3. **Контрольная точка A**: Предварительная проверка среды — Проверка версий runtime, зависимостей, доступности сервисов; при сбое ожидание решения пользователя
+4. Использование Task Worker для параллельной рассылки разработки для каждой платформы
+5. Проверка интеграции: Выравнивание API-контрактов, согласованность данных
+6. Вывод отчета о доставке
+
+**Результат**:
+```
+# Исходный код записан в фактический каталог исходного кода проекта
+iterations/{iter}/04.development/
+├── {platform-id}/
+│   └── tasks/                      # Записи задач разработки
+└── delivery-report.md
+```
+
+**Контрольный список подтверждения**:
+- [ ] Среда готова?
+- [ ] Проблемы интеграции в приемлемых пределах?
+- [ ] Код соответствует спецификациям разработки?
+
+---
+
+### 4.5 Этап 5: Тестирование системы (Test Manager)
+
+**Как начать**:
+```
+@speccrew-test-manager начать тестирование
+```
+
+**Трехэтапный процесс тестирования**:
+
+| Этап | Описание | Контрольная точка |
+|------|----------|-------------------|
+| Проектирование тест-кейсов | Генерация тест-кейсов на основе PRD и Feature Spec | A: Показать статистику покрытия кейсов и матрицу трассировки, ожидание подтверждения пользователем достаточного покрытия |
+| Генерация тестового кода | Генерация исполняемого тестового кода | B: Показать сгенерированные тестовые файлы и маппинг кейсов, ожидание подтверждения пользователя |
+| Выполнение тестов и отчет о багах | Автоматическое выполнение тестов и генерация отчетов | Нет (автоматическое выполнение) |
+
+**Результат**:
+```
+iterations/{iter}/05.system-test/
+├── cases/
+│   └── {platform-id}/              # Документы тест-кейсов
+├── code/
+│   └── {platform-id}/              # План тестового кода
+├── reports/
+│   └── test-report-{date}.md       # Отчет о тестировании
+└── bugs/
+    └── BUG-{id}-{title}.md         # Отчеты о багах (один файл на баг)
+```
+
+**Контрольный список подтверждения**:
+- [ ] Покрытие кейсов полное?
+- [ ] Тестовый код исполняемый?
+- [ ] Оценка серьезности багов точна?
+
+---
+
+### 4.6 Этап 6: Архивирование
+
+Итерации архивируются автоматически при завершении:
+
+```
+speccrew-workspace/iteration-archives/
+└── {номер}-{тип}-{имя}-{дата}/
+    ├── 01.product-requirement/
+    ├── 02.feature-design/
+    ├── 03.system-design/
+    ├── 04.development/
+    └── 05.system-test/
+```
+
+---
+
+## 5. Обзор базы знаний
+
+### 5.1 Бизнес-база знаний (bizs)
+
+**Назначение**: Хранение описаний бизнес-функций проекта, разделений модулей, характеристик API
+
+**Структура каталогов**:
+```
+knowledges/bizs/
+├── {platform-type}/
+│   └── {module-name}/
+│       └── feature-spec.md
+└── system-overview.md
+```
+
+**Сценарии использования**: Product Manager, Feature Designer
+
+### 5.2 Техническая база знаний (techs)
+
+**Назначение**: Хранение технологического стека проекта, архитектурных соглашений, спецификаций разработки, спецификаций тестирования
+
+**Структура каталогов**:
+```
+knowledges/techs/{platform-id}/
+├── tech-stack.md
+├── architecture.md
+├── dev-spec.md
+├── test-spec.md
+└── INDEX.md
+```
+
+**Сценарии использования**: System Designer, System Developer, Test Manager
+
+---
+
+## 6. Часто задаваемые вопросы (FAQ)
+
+### В1: Что делать, если Агент не работает как ожидается?
+
+1. Выполните `speccrew doctor` для проверки целостности установки
+2. Подтвердите, что база знаний инициализирована
+3. Подтвердите, что результаты предыдущего этапа существуют в текущем каталоге итерации
+
+### В2: Как пропустить этап?
+
+**Не рекомендуется** — Вывод каждого этапа является вводом для следующего этапа.
+
+Если необходимо пропустить, подготовьте вручную входной документ соответствующего этапа и убедитесь, что он соответствует спецификациям формата.
+
+### В3: Как обрабатывать несколько параллельных требований?
+
+Создайте независимые каталоги итераций для каждого требования:
+```
+iterations/
+├── 001-feature-xxx/
+├── 002-feature-yyy/
+└── 003-feature-zzz/
+```
+
+Каждая итерация полностью изолирована и не влияет на другие.
+
+### В4: Как обновить версию SpecCrew?
+
+- **Глобальное обновление**: `npm update -g speccrew`
+- **Обновление проекта**: Выполните `speccrew update` в каталоге проекта
+
+### В5: Как посмотреть исторические итерации?
+
+После архивирования смотрите в `speccrew-workspace/iteration-archives/`, организовано в формате `{номер}-{тип}-{имя}-{дата}/`.
+
+### В6: Нужна ли базе знаний регулярная актуализация?
+
+Реинициализация требуется в следующих ситуациях:
+- Значительные изменения структуры проекта
+- Обновление или замена технологического стека
+- Добавление/удаление бизнес-модулей
+
+---
+
+## 7. Быстрая справка
+
+### Быстрая справка по запуску Агентов
+
+| Этап | Агент | Начальный диалог |
+|------|-------|-------------------|
+| Диагностика | Team Leader | `@speccrew-team-leader диагностировать проект` |
+| Инициализация | Team Leader | `@speccrew-team-leader инициализировать техническую базу знаний` |
+| Анализ требований | Product Manager | `@speccrew-product-manager у меня новое требование: [описание]` |
+| Проектирование функций | Feature Designer | `@speccrew-feature-designer начать проектирование функций` |
+| Проектирование системы | System Designer | `@speccrew-system-designer начать проектирование системы` |
+| Разработка | System Developer | `@speccrew-system-developer начать разработку` |
+| Тестирование системы | Test Manager | `@speccrew-test-manager начать тестирование` |
+
+### Контрольный список контрольных точек
+
+| Этап | Количество контрольных точек | Ключевые элементы проверки |
+|------|-----------------------------|---------------------------|
+| Анализ требований | 1 | Точность требований, полнота бизнес-правил, измеримость критериев приемки |
+| Проектирование функций | 1 | Покрытие сценариев, ясность взаимодействия, полнота данных, обработка исключений |
+| Проектирование системы | 2 | A: Оценка фреймворка; B: Синтаксис псевдокода, кросс-платформенная согласованность, обработка ошибок |
+| Разработка | 1 | A: Готовность среды, проблемы интеграции, спецификации кода |
+| Тестирование системы | 2 | A: Покрытие кейсов; B: Исполняемость тестового кода |
+
+### Быстрая справка по путям результатов
+
+| Этап | Выходной каталог | Формат файла |
+|------|-----------------|-------------|
+| Анализ требований | `iterations/{iter}/01.product-requirement/` | `[name]-prd.md`, `[name]-bizs-modeling.md` |
+| Проектирование функций | `iterations/{iter}/02.feature-design/` | `[name]-feature-spec.md` |
+| Проектирование системы | `iterations/{iter}/03.system-design/` | `DESIGN-OVERVIEW.md`, `{platform}/INDEX.md`, `{platform}/{module}-design.md` |
+| Разработка | `iterations/{iter}/04.development/` | Исходный код + `delivery-report.md` |
+| Тестирование системы | `iterations/{iter}/05.system-test/` | `cases/`, `code/`, `reports/`, `bugs/` |
+| Архивирование | `iteration-archives/{iter}-{дата}/` | Полная копия итерации |
+
+---
+
+## Следующие шаги
+
+1. Выполните `speccrew init --ide qoder` для инициализации вашего проекта
+2. Выполните Нулевой шаг: Диагностика проекта и инициализация базы знаний
+3. Продвигайтесь через каждый этап следуя рабочему процессу, наслаждаясь опытом разработки на основе спецификаций!