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

Зачем документация

Это один из самых важных уроков курса. Большинство людей хотят сразу «делать» — писать код, создавать страницы. Но без документации процесс разработки превращается в хаос. А мы тут не за этим.


Проблема

Представь: хочешь сделать сайт для своего бизнеса.

Что обычно делают:

Сделай мне сайт для магазина одежды

Claude делает... что-то. Какой-то сайт. Но не то что хотелось.

Начинаешь уточнять. Переделывать. Ещё раз. Часы уходят на то, что можно было сделать за минуты.

Почему так: нет чёткого понимания что нужно. А Claude — не телепат.


Решение

Сначала подумать. Записать. Потом делать.

Для этого существует документация — описание того, что хочешь получить, ДО того как написана первая строка кода.

💡 Простыми словами: Документация — это план. Как чертёж перед строительством дома. Можно строить без чертежа, но результат будет непредсказуемым.


Два типа документации

1. Проектная документация (общая)

Описание всего проекта целиком — твой архив знаний:

Всё что можешь собрать — складывай в проектную документацию.

2. Техническая документация (для кода)

Описание конкретной функции перед реализацией:

Техническую документацию пишут перед внедрением каждой новой фичи.

💡 Простыми словами: Проектная документация — «что я хочу построить в целом». Техническая — «как построить конкретную комнату в этом доме».


Почему это работает

1. Ты понимаешь что хочешь.

Записываешь мысли — они становятся конкретными. «Магазин одежды» → «три категории, корзина, форма заказа, страница о нас».

2. Claude понимает что делать.

Чем подробнее описание — тем точнее результат.

3. Можно вернуться и свериться.

Через неделю забудешь что планировалось. Документация напомнит.

4. Можно показать другим.

Хочешь совет? Покажи описание проекта.


Как это выглядит

# Мой интернет-магазин одежды

## Что это
Сайт для продажи одежды собственного бренда.

## Для кого
Молодые люди 20-35 лет, которые ищут стильную одежду.

## Основные страницы
- Главная: баннер + популярные товары
- Каталог: три категории (мужское, женское, аксессуары)
- Страница товара: фото, описание, размеры, кнопка «в корзину»
- Корзина: список товаров, итоговая сумма
- Оформление: форма с контактами

## Чего НЕ будет (пока)
- Регистрация и личный кабинет
- Онлайн-оплата
- Отзывы

Это не код. Это простой текст. Но теперь и ты, и Claude точно знаете что делать.


Ручка и бумага

Перед документацией набросай мысли на бумаге. Серьёзно. 15–30 минут.

Нарисуй схему. Выпиши пункты. Это помогает:

Потом перенесёшь в документ. Claude поможет структурировать.


Цикл работы

1. Набросать мысли (бумага)
     ↓
2. Записать документацию (файл)
     ↓
3. Показать Claude, попросить дополнить
     ↓
4. Перепроверить — всё ли учтено?
     ↓
5. Начать делать

Документация не высечена в камне. Она меняется по ходу. Но старт с неё — обязателен.


Практика

Подумай о проекте который хочешь сделать. Возьми ручку и бумагу:

  1. Что это? (одно предложение)

  2. Для кого? (кто будет пользоваться)

  3. Что должно быть? (3–5 главных функций)

  4. Чего НЕ будет? (что не делаем, хотя бы пока)


Тест

1. Зачем нужна документация?

2. Какие два типа документации важны?

3. С чего лучше начать?

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