#какэтоработает

- Заходит продакт в бар к техписателям и говорит: "У нас завтра релиз, нужна дока!"

Всем привет! Бывает ли у вас так, как в этой грустной непридуманной шутке? Вот у нас бывало( Как избежать подобных ситуаций?

Раннее документирование

Shift-left документирование или документирование со сдвигом влево — называть этот процесс можно по-разному. Суть в нём одна: технический писатель приступает к описанию продукта как можно раньше.

Когда возможно раннее документирование?

1. Технический писатель интегрирован в команду: он знает продукт, представляет темпы работы команды, примерно понимает, к чему движется команда и у него есть доступ к доске с задачами.
2. В команде выстроены процессы: к задаче с фичёй или к эпику пишется чёткое, полное и протестированное задание. Как мы однажды выстроили процесс с докой, расскажем в одном из следующих постов.

Когда приступать к работе?

При раннем документировании техписатель составляет черновик документации на основании технического задания. Сделать это можно, когда разработчик даже ещё не взял задачу в работу. В этот момент можно:
*️⃣ определить место этой фичи в общей структуре документации,
*️⃣ установить её связь с другими функциональностями,
*️⃣ составить последовательность действий при разных сценариях.

После подготовки черновика нужно дождаться, когда задача перейдёт в стадию ручного тестирования, и тогда убедиться в корректности своих текстов и добавить недостающие скрины.

Какие плюсы и минусы?

➕ Документация готова до релиза.
➕ Техписатель может планировать и распределять свою нагрузку, если описывает несколько продуктов.
➖ Он должен быть погружён в продукт, то есть поддерживать постоянную связь с разработкой.
➖ Задача может не попасть в релиз. Но этого минуса нет, если используется docs-as-code и подход одна фича — одна ветка. Просто вольёте эту ветку в нужный релиз.

А вы пробовали такой подход? Какие минусы заметили ещё?

Всем привет!

Сегодня у нас снова интерактивная и предновогодняя #мемница

Собрали для вас техписательское бинго не без приколдесов конечно 😄
Забирайте и делитесь с коллегами! А в комментах можете показать, какие страйки вы выбили 😏

Всем привет в новом году!

Врываемся в рабочие будни сразу с серьёзного вопроса: как начать год продуктивно?

1. Вспомните всё: я — технический писатель, я делаю мир лучше 💪
2. Проверьте или составьте план на 2025. Если вы принципиально не составляете планы, то проверьте сроки задач, которые выполняете. Но начало года — время пробовать что-то новое, так что попробуйте хотя бы набросать план 🙂
3. Встретьтесь или созвонитесь с командой, чтобы вместе настроиться на работу 🤝

Начало года — отличная точка, чтобы посмотреть на то, к чему вы хотите прийти через год. И планы — хороший способ структурировать своё время и наметить примерный путь.

Подумайте, что вы хотите — это могут быть как рабочие планы, так и личностные, но касающиеся работы. Например, рабочие планы:
🟠 начать и завершить грандиозный проект;
🟠 обновить документацию;
🟠 переделать раздел документации;
🟠 повысить грейд.

И личностные:
🟢 понять, как работают облачные сервисы;
🟢 сменить работу;
🟢 начать больше зарабатывать;
🟢 выступить на конференции.

Необязательно составлять пошаговый план, но для начала можно составить список хотелок, расставить приоритеты и наметить какие-то сроки. Например: хочу сделать грандиозный проект на работе за первый квартал, к середине года повысить грейд и зарплату, а осенью выступить спикером на митапе. Лучше всего даже такие наброски где-то записать и держать если не перед глазами, то в месте, в которое вы часто обращаетесь. Это важно, чтобы не забыть свои желания, потому что в веренице рутины и работы фокус внимания может сместиться. И к концу года вы обнаружите, что не сделали ничего, что хотели.

Но самое главное — соблюдайте work-life balance, иначе любые планы и желания станут уже не так важны. Потому что какой смысл быть лидом или больше зарабатывать, если ты выгорел или сошёл с ума 😏

А как вы начинаете свою работу в этом году?

#twd2 #анонсдоклада
Всем привет! Знакомим вас с докладами TechWriterDays#2.

Итак, что интереснее — котики или интерактивное изучение API? 🥰

Техписатель из WB Лидия Рудакова объединила это всё в один увлекательный мастер-класс:

REST and Peace: пишем спецификацию OpenAPI в Redocly

Что в планах:
👋 Подёргать "ручки" API, узнать факты о котиках,
😍 Серьёзно описать шутливый кошачий API в спецификации OpenAPI в Redocly,
😉 Посмотреть, как разворачивается портал с документацией, и увидеть, как это сделала команда WebAPI в Wildberries.

Для лучшего эффекта приходите с ноутами и установленными IDE, с VS Code, например.

👉 Вся программа конференции TechWriterDays #2 уже опубликована. TWD#2 — это 60+ докладов и мастер-классов и возможность пообщаться с 400+ участниками из сотен компаний России и ближнего зарубежья. Конференция пройдёт 28 и 29 марта в Санкт-Петербурге по адресу ул. Стартовая 6, лит. А. Это пространство отеля Airportcity Plaza, проживание в отеле для участников - со скидкой по промокоду.