Зачем документация
Это самый важный урок курса. САМЫЙ. Большинство людей хотят сразу "делать" — писать код, создавать страницы. И я тоже :) Но это тупик сто процентный. Отвечаю. Без документации никакого вайбкодинга не получится, и процесс разработки превратится в сатанистский ад. А мы тут не за этим!
[ ПРОБЛЕМА ]
Представь: ты хочешь сделать сайт для своего бизнеса.
Что обычно делают:
Claude делает... что-то. Какой-то сайт. Но это не то что ты хотел.
Начинаешь уточнять. Переделывать. Ещё раз переделывать. Часы уходят на то, что можно было сделать за минуты.
Почему так происходит:
Ты сам не понимаешь что хочешь. А Claude не телепат.
[ РЕШЕНИЕ ]
Сначала подумать. Записать. Потом делать. Для этого и существует документация — описание того, что ты хочешь получить, до того как написана первая строка кода.
Документация это план. Как чертёж перед строительством дома. Можно строить без чертежа, но результат будет... непредсказуемым.
[ ДВА ТИПА ДОКУМЕНТАЦИИ ]
Документация бывает разная. Пока тебе достаточно двух типов:
Проектная документация (общая)
Это описание всего проекта целиком — твой архив знаний:
- Что за проект, какая идея
- Для кого он, кто аудитория
- Какую проблему решает
- Основные функции и возможности
- Данные о рынке и конкурентах
- Какие фичи есть у конкурентов
- Какие инструменты и технологии планируешь использовать
Всё что можешь нагрести и собрать — складывай в проектную документацию. Это такая база знаний, к которой ты и Claude будете возвращаться на разных этапах работы. С этого ты начнёшь в следующем уроке.
Техническая документация (для кода)
Это описание конкретной функции перед её реализацией:
- Что за фича, что она должна делать
- Как это работает у конкурентов
- Какие технологии использовать
- Как она связана с остальным проектом
Техническую документацию пишут перед внедрением каждой новой фичи. Ты описываешь что хочешь, можешь попросить Claude посмотреть как это сделано у других — и только потом начинаешь разработку. Это понадобится позже, когда начнёшь разрабатывать проект.
Проектная документация это "что я хочу построить в целом". Техническая — это "как построить конкретную комнату в этом доме". Обе важны пздц!
[ ПОЧЕМУ ЭТО РАБОТАЕТ ]
Ты понимаешь что хочешь
Когда записываешь мысли, они становятся конкретными. "Магазин одежды" превращается в "Три категории: мужское, женское, детское. Корзина. Форма заказа. Страница о нас."
Claude понимает что делать
Чем подробнее описание, тем точнее результат. Не надо по 10 раз переделывать.
Можно вернуться и свериться
Через неделю забудешь что планировал. Документация напомнит.
Можно показать другим
Хочешь совет? Покажи описание проекта. Человек поймёт без объяснений на пальцах.
[ КАК ЭТО ВЫГЛЯДИТ ]
Простой пример документации проекта:
Это не код. Это простой текст. Но теперь и ты и Claude точно знаете что делать.
[ РУЧКА И БУМАГА ]
Перед тем как писать документацию, набросай мысли на бумаге.
Вначале. Ручка. Бумага. 15-30 минут.
Нарисуй схему. Выпиши пункты. Как по кайфу.
Это помогает:
- Вытащить мысли из головы
- Увидеть картину целиком
- Заметить что забыл
Потом переносишь в документ. Claude поможет структурировать. Если схема получится понятной, то можно даже зафоткать и отправить в чат. я часто так делаю.
[ ЦИКЛ РАБОТЫ ]
Вот как это работает на практике:
Документация не высечена в камне. Она меняется по ходу. Но старт с неё обязателен. И управлять проектом без неё нормально тоже не получится.
[ ЧТО БУДЕТ ДАЛЬШЕ ]
В следующих уроках:
- Урок 10: Пишем документацию вместе с Claude
- Урок 11: Как улучшать документацию — цикл проверок
После этого модуля ты сможешь начать свой проект. Не учебный, а уже реальный. И начнёшь правильно. Как опытный тип!
[ ПРАКТИКА ]
Подумай о проекте который хочешь сделать. Любой: сайт, бот, приложение.
Возьми ручку и бумагу. Напиши ответы:
- Что это? (одно предложение)
- Для кого? (кто будет этим пользоваться)
- Что должно быть? (3-5 главных функций)
- Чего НЕ будет? (что не делаем, хотя бы пока)
Не надо делать сейчас. Просто набросай.
Я с самого рождения, всегда, хотел сделать "всё и сразу". И первое время, по этой причине игнорил документацию, и тупо начинал создавать проект с разбега. Но ни один проектов, созданных таким образом, не дожил до сегодняшнего дня :)
Поэтому теперь я 80% работы думаю, и только 20% говорю задания агентам. И это пашет намного стабильнее. Один раз нормально всё продумаешь — и сразу сэкономишь себе десятки часов на переделки. Проверено миллион раз.