← НАЗАД К CLAUDE CODE Модуль 3: Документация · Урок 2 из 3

Пишем документацию

В прошлом уроке были наброски идеи. Теперь превратим их в документ.


Шаг 1: Расскажи идею Claude

Открой Claude Code и просто расскажи свою идею. Как другу. Без структуры.

Хочу сделать телеграм-бота для своей кофейни. Чтобы люди могли
смотреть меню и делать предзаказ. Выбираешь напиток, говоришь
когда заберёшь, приходишь — уже готово. Ещё хочу программу
лояльности, каждый 5-й кофе бесплатно.

Попроси структурировать:

Помоги превратить это в документацию проекта.
Сделай структуру: что это, для кого, основные функции.

Claude создаст структурированный документ.


Шаг 2: Попроси найти информацию

Claude знает много. Используй это:

Claude найдёт информацию и предложит идеи. Ты выбираешь что подходит.

💡 Совет: Не принимай всё. Это предложения. Выбирай что нравится. И заставляй Claude сомневаться в своих идеях — так результат лучше.


Шаг 3: Запиши в файл

Когда документ нравится:

Создай файл docs/project.md с этой документацией

Пример диалога

  1. Ты: Хочу сделать сайт-портфолио для фрилансера. Делаю дизайн и иллюстрации. Нужно показать работы и связаться.

  2. Claude: предлагает структуру

  3. Ты: Добавь раздел с ценами. Убери блог — не буду вести.

  4. Claude: обновляет

  5. Ты: Какие разделы обычно есть на портфолио дизайнеров?

  6. Claude: отзывы, процесс работы, FAQ

  7. Ты: Отзывы — хорошо, добавь. Остальное не надо.

  8. Ты: Создай файл docs/project.md с этой документацией


Структура документации

# Название проекта

## Что это
Краткое описание в 1-2 предложения.

## Для кого
Кто будет пользоваться.

## Проблема
Какую проблему решает.

## Основные функции
- Функция 1
- Функция 2
- Функция 3

## Страницы / экраны
Что увидит пользователь.

## Чего НЕ будет (пока)
Что сознательно не делаем.

## Технические заметки
Платформа, ограничения, интеграции.

Техническая документация

Перед каждой новой фичей:

Хочу добавить программу лояльности. Помоги разобраться:
как это обычно делают? Какие варианты? Как хранить баллы?

Потом:

Создай файл docs/features/loyalty-program.md с описанием

💡 Когда писать техдок:

  • Перед новой функцией

  • Когда задача сложная

  • Когда нужно изучить как делают другие

Когда НЕ нужно:

  • Мелкие правки

  • Очевидные изменения


Для серьёзных проектов: GSD

Когда проект сложнее одной страницы — есть инструмент, который автоматизирует всю документацию и планирование.

GSD (Get Shit Done) — это отдельный агент, который устанавливается поверх Claude Code. Он берёт на себя то, что ты делаешь вручную в шагах выше, но на другом уровне: проводит исследование, создаёт дорожную карту, разбивает проект на фазы с конкретными задачами и генерирует документацию автоматически.

Сейчас об этом рано — сначала нужно освоить основы Claude Code. Но когда будешь готов к серьёзным проектам, у меня есть отдельный курс по GSD, где всё разобрано пошагово.


Практика

  1. Открой Claude Code

  2. Расскажи идею своими словами

  3. Попроси структурировать

  4. Спроси что упущено

  5. Выбери нужное

  6. Сохрани в файл

⚠️ Важно: Не пытайся сделать идеально. Документация будет меняться. Сейчас важно зафиксировать основу.


Тест

1. Как начать писать документацию?

2. Нужно ли принимать все предложения Claude?

3. Когда писать техническую документацию?

← ПРЕДЫДУЩИЙ СЛЕДУЮЩИЙ →