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

Это 10-минутное пошаговое руководство. Если вы хотите получить более медленное, полностью аннотированное руководство с восстановлением после ошибок, см. Руководство по первому артефакту.

К концу этой страницы вы получите:

Инициализированное рабочее пространство Forgeplan
Роутированный и валидированный PRD
Зафиксированное ADI-обоснование
Доказательство, связанное с PRD
Оценку R_eff > 0
Артефакт в состоянии active

0. Установка

Если вы ещё не установили Forgeplan, см. Установка.

Убедитесь, что он работает:

forgeplan --version
# forgeplan 0.18.0

1. Инициализация рабочего пространства

cd /path/to/your/project
forgeplan init -y

Это создаёт .forgeplan/ с пустыми директориями prds/, rfcs/, adrs/, evidence/ и файлом config.yaml. Флаг -y пропускает интерактивные запросы (требуется для ИИ-агентов).

forgeplan health
# -> 0 артефактов, 0 слепых пятен. Рабочее пространство готово.

2. Роутинг вашей задачи

Прежде чем что-либо писать, позвольте Forgeplan выбрать правильную глубину:

forgeplan route "add user authentication"

Глубина: Standard
Конвейер: PRD → RFC
Уверенность: 90%
Далее: forgeplan new prd "Аутентификация пользователя"

Standard означает, что вы создаёте PRD для “что” и RFC для “как”. Для получения дополнительной информации см. Роутинг и глубина.

3. Shape - создание PRD

forgeplan new prd "User Authentication"
# -> Создано: PRD-001 в .forgeplan/prds/PRD-001-user-authentication.md

Откройте файл и заполните обязательные (MUST) разделы:

Проблема - почему это существует?
Цели - как выглядит успех? (критерии SMART)
Не-цели - что явно выходит за рамки?
Целевые пользователи - кто получает выгоду?
Функциональные требования (FR) - [Актер] может [возможность]

4. Валидация

forgeplan validate PRD-001

Ожидается:

PRD-001: ПРОЙДЕНО ✓ (0 ошибок MUST, 2 предупреждения SHOULD)

Если вы видите ошибки MUST, разделы отсутствуют или пусты. Исправьте их и запустите снова. Валидатор также обнаруживает утечку реализации: написание “Использовать JWT” в требовании приводит к сбою гейта - требования описывают ЧТО, а не КАК.

5. Обоснование (ADI)

Для глубины Standard рекомендуется ADI. Для Deep и Critical это обязательно:

forgeplan reason PRD-001

Роутер генерирует 3+ гипотезы, выводит предсказания для каждой и оценивает их на основе любых доказательств, уже имеющихся в рабочем пространстве. Вывод сохраняется вместе с артефактом, чтобы будущие читатели могли видеть, как вы пришли к решению.

Хотите, чтобы контекст базы знаний FPF был внедрён в промпт?

forgeplan reason PRD-001 --fpf

См. ADI-обоснование для полного цикла.

6. Сборка

Напишите код для вашей фичи. Критическое правило: напишите тест для каждой pub fn перед переходом к следующей функции. Тесты становятся Доказательством на шаге 7.

Когда фича готова:

cargo test       # или ваш эквивалент
cargo fmt
cargo check

Все должно быть зелёным, прежде чем вы активируете.

7. Доказательство - создание Доказательства

forgeplan new evidence "Auth tests - 12 pass, JWT validate 0.3ms"
# -> Создано: EVID-001

Откройте файл доказательства и добавьте блок структурированных полей в тело:

## Structured Fields

verdict: supports
congruence_level: 3
evidence_type: test

Без этих полей парсер R_eff присваивает CL0 (штраф 0.9), и ваш балл падает почти до нуля. Это самая распространённая ошибка новичков.

Свяжите доказательство с PRD:

forgeplan link EVID-001 PRD-001 --relation informs

8. Проверка оценки

forgeplan score PRD-001

PRD-001: R_eff = 1.00 - Адекватно
  EVID-001: поддерживает, CL3, test -> оценка 1.0

Если R_eff равен 0.0, проверьте: (а) связано ли доказательство? (б) содержит ли тело доказательства структурированные поля? См. Доказательство и R_eff.

9. Активация

forgeplan review PRD-001
# -> Проверка ПРОЙДЕНА - готово к активации

forgeplan activate PRD-001
# -> draft → active

Гейт валидации запускается ещё раз при активации. Если он завершается неудачей, переход отклоняется.

10. Проверка состояния

forgeplan health

Артефакты: 1 (1 active, 0 draft, 0 stale)
Слепые пятна: 0
Сироты (артефакты без связей): 0
Покрытие доказательствами: 100%

Теперь у вас есть полностью отслеживаемое решение с измеримым уровнем доверия. Вы в будущем (или ваш коллега) сможете открыть PRD-001 через шесть месяцев и увидеть: проблему, цели, ADI-гипотезы, выбранный подход и доказательства, которые его обосновывают.

Полный цикл (шпаргалка)

Роутинг → Shape → Validate → Обоснование → Сборка → Доказательство → Activate
  1        2        3         4       5       6         7

1. forgeplan route "задача"
2. forgeplan new prd "Заголовок"     # заполнить обязательные (MUST) разделы
3. forgeplan validate PRD-XXX
4. forgeplan reason PRD-XXX      # ADI, обязательно для Deep+
5. код + тест
6. forgeplan new evidence "..." + link + score
7. forgeplan review + activate

Следующие шаги

Руководство по первому артефакту - 20-минутная версия с пошаговыми инструкциями и восстановлением после ошибок
Обзор методологии - 10 правил
Справочник CLI - каждая команда задокументирована
Конфигурация - провайдеры LLM, эмбеддинги, синхронизация с git
Обзор маркетплейса - плагины для /audit, /sprint, /fpf и других