#мемница

Все техписы — котики! 🐈‍⬛

#выпуск 17 #практика

Всем привет!

😎 На этом занятии не будет скучных лекций и дурацких взмахов волшебной палочки!

А всё дело в том, что недавно мы нашли два классных ресурса, которые помогут прокачать техписательские техскилы 💪 Естественно, не можем ими не поделиться!

*️⃣Интерактивный курс по git — https://learngitbranching.js.org/?locale=ru_RU

*️⃣Изучаем SQL, раскрывая преступления — https://www.sqlnoir.com/

Приглашаем в комменты поделиться своими любимыми ресурсами)

#мемница

Или наоборот? 😄

Всем привет! 👋

Иногда варишься в своей работе, варишься, делаешь, как привык, как, думаешь, делают все. А потом неожиданно открываешь новый способ работы, начинаешь с ним делиться, и оказывается… и оказывается, что это не новый способ работы 🤔

Давайте поговорим о том, какие есть способы написания документации! Вот какие варианты встречались нам:

✍️ Потыкаться самому / Побыть писателем

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

📝 Отредактировать черновик / Побыть редактором

Некоторые заказчики приносят черновики — это могут быть те же юз-кейсы, которые просто нужно оформить, отредактировать по стайлгайду, посмотреть, что всей информации достаточно. Черновики могут быть любого плана, главное — свести всё воедино в красивый и понятный текст.

✍️ Провести интервью / Побыть журналистом

Иногда у людей вызывает отторжение сама мысль о том, чтобы написать доку, тем более если есть техписатель. Один из способов что-то узнать — встретиться и обсудить фичу с заказчиком или носителем знаний. Поясните, что вам от него нужно, и предложите встретиться. Тысяча слов вместо тысячи букв иногда продуктивнее. Особенно если поставить выбор — пиши черновик сам или расскажи мне всё, что знаешь.

✍️ Стать Шерлоком

А можно поискать по тикетам, чатам, кодам, внутренним страницам какие-то артефаты по продукту. Ведь вряд ли разработчикам кто-то что-то сказал на словах и они тут же всё сделали. Скорее всего, где-то есть описания задачи от продакта, аналитика, лида или других заинтересованных лиц. Собираете информацию и сводите всё в один документ. Вуаля — у вас уже что-то есть, что можно отдать заказчику или к чему можно задать вопросы. Поправить доку или ответить на конкретные вопросы проще, чем самому писать с нуля. Поэтому шансы, что вам ответят, возрастают.

Вообще, в нашей работе нельзя использовать только какой-то один способ. Обычно используются все — смотря какая fabric задача, смотря сколько details дано изначально.

Расскажите, есть ли у вас какие-то свои способы работы?

#выпуск 18

🚀 Всем привет!
Уже завтра стартует TechWriter Days 2.

✍️ Регистрация участников начнется в 9:00 на первом этаже отеля в зоне «Регистрация».

📖 Церемония открытия начнётся в 09:30 в секции А. Открытие транслируется во все залы, так что можете проходить в любую секцию.

🍴 Про обед тоже не забыли! Он начнётся в 13:00 и будет проходить в две смены. Не забудьте взять на него талон на стойке регистрации.

Пссс, хотите немного мерча? На некоторых докладах будем разыгрывать небольшие призы от нашего канала! Так что не стесняйтесь задавать вопросы 😎

А ещё мы будем на конференции в полном составе, подходите познакомиться и пообщаться! 🙊

📌 Расписание конференции