Всем привет! 👋
Иногда варишься в своей работе, варишься, делаешь, как привык, как, думаешь, делают все. А потом неожиданно открываешь новый способ работы, начинаешь с ним делиться, и оказывается… и оказывается, что это не новый способ работы🤔
Давайте поговорим о том, какие есть способы написания документации! Вот какие варианты встречались нам:
✍️ Потыкаться самому / Побыть писателем
Если нужна пользовательская документация, то легче всего написать её самостоятельно, потыкав кнопки интерфейса. Если у вас есть юз-кейсы — сделать это легче простого. В противном случае придётся немного подумать, что и как может сделать пользователь.
Если нужна техническая дока — можно почитать код, если есть возможность и скиллы.
📝 Отредактировать черновик / Побыть редактором
Некоторые заказчики приносят черновики — это могут быть те же юз-кейсы, которые просто нужно оформить, отредактировать по стайлгайду, посмотреть, что всей информации достаточно. Черновики могут быть любого плана, главное — свести всё воедино в красивый и понятный текст.
✍️ Провести интервью / Побыть журналистом
Иногда у людей вызывает отторжение сама мысль о том, чтобы написать доку, тем более если есть техписатель. Один из способов что-то узнать — встретиться и обсудить фичу с заказчиком или носителем знаний. Поясните, что вам от него нужно, и предложите встретиться. Тысяча слов вместо тысячи букв иногда продуктивнее. Особенно если поставить выбор — пиши черновик сам или расскажи мне всё, что знаешь.
✍️ Стать Шерлоком
А можно поискать по тикетам, чатам, кодам, внутренним страницам какие-то артефаты по продукту. Ведь вряд ли разработчикам кто-то что-то сказал на словах и они тут же всё сделали. Скорее всего, где-то есть описания задачи от продакта, аналитика, лида или других заинтересованных лиц. Собираете информацию и сводите всё в один документ. Вуаля — у вас уже что-то есть, что можно отдать заказчику или к чему можно задать вопросы. Поправить доку или ответить на конкретные вопросы проще, чем самому писать с нуля. Поэтому шансы, что вам ответят, возрастают.
Вообще, в нашей работе нельзя использовать только какой-то один способ. Обычно используются все — смотря какаяfabric задача, смотря сколько details дано изначально.
Расскажите, есть ли у вас какие-то свои способы работы?
#выпуск 18
Иногда варишься в своей работе, варишься, делаешь, как привык, как, думаешь, делают все. А потом неожиданно открываешь новый способ работы, начинаешь с ним делиться, и оказывается… и оказывается, что это не новый способ работы
Давайте поговорим о том, какие есть способы написания документации! Вот какие варианты встречались нам:
Если нужна пользовательская документация, то легче всего написать её самостоятельно, потыкав кнопки интерфейса. Если у вас есть юз-кейсы — сделать это легче простого. В противном случае придётся немного подумать, что и как может сделать пользователь.
Если нужна техническая дока — можно почитать код, если есть возможность и скиллы.
Некоторые заказчики приносят черновики — это могут быть те же юз-кейсы, которые просто нужно оформить, отредактировать по стайлгайду, посмотреть, что всей информации достаточно. Черновики могут быть любого плана, главное — свести всё воедино в красивый и понятный текст.
Иногда у людей вызывает отторжение сама мысль о том, чтобы написать доку, тем более если есть техписатель. Один из способов что-то узнать — встретиться и обсудить фичу с заказчиком или носителем знаний. Поясните, что вам от него нужно, и предложите встретиться. Тысяча слов вместо тысячи букв иногда продуктивнее. Особенно если поставить выбор — пиши черновик сам или расскажи мне всё, что знаешь.
А можно поискать по тикетам, чатам, кодам, внутренним страницам какие-то артефаты по продукту. Ведь вряд ли разработчикам кто-то что-то сказал на словах и они тут же всё сделали. Скорее всего, где-то есть описания задачи от продакта, аналитика, лида или других заинтересованных лиц. Собираете информацию и сводите всё в один документ. Вуаля — у вас уже что-то есть, что можно отдать заказчику или к чему можно задать вопросы. Поправить доку или ответить на конкретные вопросы проще, чем самому писать с нуля. Поэтому шансы, что вам ответят, возрастают.
Вообще, в нашей работе нельзя использовать только какой-то один способ. Обычно используются все — смотря какая
Расскажите, есть ли у вас какие-то свои способы работы?
#выпуск 18
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥40👍17❤1
🚀 Всем привет!
Уже завтра стартует TechWriter Days 2.
✍️ Регистрация участников начнется в 9:00 на первом этаже отеля в зоне «Регистрация».
📖 Церемония открытия начнётся в 09:30 в секции А. Открытие транслируется во все залы, так что можете проходить в любую секцию.
🍴 Про обед тоже не забыли! Он начнётся в 13:00 и будет проходить в две смены. Не забудьте взять на него талон на стойке регистрации.
Пссс, хотите немного мерча? На некоторых докладах будем разыгрывать небольшие призы от нашего канала! Так что не стесняйтесь задавать вопросы 😎
А ещё мы будем на конференции в полном составе, подходите познакомиться и пообщаться!🙊
📌 Расписание конференции
Уже завтра стартует TechWriter Days 2.
А ещё мы будем на конференции в полном составе, подходите познакомиться и пообщаться!
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥14✍11👍6❤2
ТechWriterDays#2 в лицах:
1. Оксана Гаврюшенко (documentat.io)
2. Анна Мария Попова (X5 Tech)
3.Мария Кисилëва (РТЛабс)
4. Админы Техписалити! - Лидия Туляганова (Wildberries), Екатерина Марченко (Индид), Мария Щеблякова (Озон).
5. Денис Ребенок (Флант), автор канала PRO_техписательство.
1. Оксана Гаврюшенко (documentat.io)
2. Анна Мария Попова (X5 Tech)
3.Мария Кисилëва (РТЛабс)
4. Админы Техписалити! - Лидия Туляганова (Wildberries), Екатерина Марченко (Индид), Мария Щеблякова (Озон).
5. Денис Ребенок (Флант), автор канала PRO_техписательство.
❤🔥44🔥8❤6👍2
#twd2
❗️Главный итог конференции — обновлённая "медиана Факторовича" — средняя зарплата техписателей в России. Теперь она составляет 146 тысяч рублей.
Мы раннее писали, что при расчете медианы не учитывались очень высокие зарплаты, 95-й процентиль, однако коллеги указали нам на ошибку. На самом деле при подсчëте учитывались все зарплаты. Благодарим коллег за внимательность и любовь к истине😊
👉 Понятие "медиана Факторовича" возникло в узких кругах техписателей после доклада Семëна Факторовича на первой TechWriterDays. На ней он впервые озвучил медианную зарплату техписателей.
И тогда, и сейчас медиану смогли подсчитать благодаря большим социологическим опросам, которые проводила компания documentat.io.
❗️Главный итог конференции — обновлённая "медиана Факторовича" — средняя зарплата техписателей в России. Теперь она составляет 146 тысяч рублей.
Мы раннее писали, что при расчете медианы не учитывались очень высокие зарплаты, 95-й процентиль, однако коллеги указали нам на ошибку. На самом деле при подсчëте учитывались все зарплаты. Благодарим коллег за внимательность и любовь к истине😊
👉 Понятие "медиана Факторовича" возникло в узких кругах техписателей после доклада Семëна Факторовича на первой TechWriterDays. На ней он впервые озвучил медианную зарплату техписателей.
И тогда, и сейчас медиану смогли подсчитать благодаря большим социологическим опросам, которые проводила компания documentat.io.
🔥37👍19🤨6👎3😁3❤2😐2
Всем привет!
Обновлено: набор на стажировку окончен.
У нас хорошие новости для новичков-студентов из Москвы и Московской области. В "Лаборатории Касперского" открываются стажировки, в том числе для технических писателей!
Из приятного — подать заявку можно сразу на три направления.
Итак, подаваться на:
● Technical Writing
Кроме этого доступны направления:
● Разработка C, C++, Java Script, Python, С#
● DevOps
● ИБ — Product Certification, Malware Analyst, Digital Footprint Intelligence & Security Assessment, Web content analyst
● SIEM Analysis
● Тестирование (ручное; авто, Python;, С#)
● SDET Android
● iOS Developer
● System Administration
Ожидают, что вы сможете отводить стажировке от 20 часов в неделю. Взамен обещают работу над реальными задачами, зарплату, компенсацию питания и прочие приятности.
Обновлено: набор на стажировку окончен.
У нас хорошие новости для новичков-студентов из Москвы и Московской области. В "Лаборатории Касперского" открываются стажировки, в том числе для технических писателей!
Из приятного — подать заявку можно сразу на три направления.
Итак, подаваться на:
● Technical Writing
Кроме этого доступны направления:
● Разработка C, C++, Java Script, Python, С#
● DevOps
● ИБ — Product Certification, Malware Analyst, Digital Footprint Intelligence & Security Assessment, Web content analyst
● SIEM Analysis
● Тестирование (ручное; авто, Python;, С#)
● SDET Android
● iOS Developer
● System Administration
Ожидают, что вы сможете отводить стажировке от 20 часов в неделю. Взамен обещают работу над реальными задачами, зарплату, компенсацию питания и прочие приятности.
👍14❤9🔥6
#опросHR
Всем привет!
В феврале мы проводили опрос и сейчас готовы представить вам его результаты
Почему мы увольняемся? Результаты опроса
Вводная часть
Мы хотели узнать, по каким причинам техписатели меняют место работы и как это происходит.
Респонденты. В опросе приняли участие 130 респондентов. Из них 95% — именно техписатели. Остальные — работники интеллектуального труда из других сфер, таких респондентов немного, мы сделаем отдельный пост, посвящённый этим ответам.
Мы расспрашивали о последнем случае увольнения. Вопросы были в двух блоках: для тех, кто уволился по желанию, и тех, кого уволили. Да, не все поняли наш посыл, и не все читали подписи к блокам вопросов, но мы техписатели — нам не привыкать, что пользователи мало читают “доку”) Поэтому мы сами отсеяли ответы, которые попали в блок по ошибке.
Опрос был довольно короткий, но результаты невозможно поместить в один пост. Поэтому будем публиковать результаты постепенно в рубрике #опросHR. Первый пост — через неделю.
Но мы не дадим вам скучать, поэтому на следующей неделе запустим новый опрос по техписательскому делу.
Всем привет!
В феврале мы проводили опрос и сейчас готовы представить вам его результаты
Почему мы увольняемся? Результаты опроса
Вводная часть
Мы хотели узнать, по каким причинам техписатели меняют место работы и как это происходит.
Респонденты. В опросе приняли участие 130 респондентов. Из них 95% — именно техписатели. Остальные — работники интеллектуального труда из других сфер, таких респондентов немного, мы сделаем отдельный пост, посвящённый этим ответам.
Мы расспрашивали о последнем случае увольнения. Вопросы были в двух блоках: для тех, кто уволился по желанию, и тех, кого уволили. Да, не все поняли наш посыл, и не все читали подписи к блокам вопросов, но мы техписатели — нам не привыкать, что пользователи мало читают “доку”) Поэтому мы сами отсеяли ответы, которые попали в блок по ошибке.
Опрос был довольно короткий, но результаты невозможно поместить в один пост. Поэтому будем публиковать результаты постепенно в рубрике #опросHR. Первый пост — через неделю.
Но мы не дадим вам скучать, поэтому на следующей неделе запустим новый опрос по техписательскому делу.
❤20👏9👍7
Всем привет!
У нас сегодня необычный пост. В этот день ровно два года назад появился канал Техписалити!
🥳 Розыгрыш мерча!
Да-да, сейчас мы об этом расскажем.
Все эти два года мы старались делиться с вами своим опытом, наблюдениями и знаниями. А чтобы вам не было тоскливо от наших назиданий — развлекали авторскими мемами и интерактивами.
Сегодня герои нашего поста — это вы, наши дорогие подписчики. Расскажите в комментариях о том, почему вы читаете наш канал, что в нём для вас ценного. Мы приветствуем искренность, поэтому если вам что-то не нравится — тоже смело пишите. Хвалите, жалуйтесь, ругайте — до 12-00 пятницы 25 апреля.
Мы по хронологии присвоим комментариям порядковые номера, а затем с помощью онлайн-рандомайзера в прямом эфире определим победителей. Именно к ним уедут наши фирменные шоперы.
Для нас все техписатели равны, но мы честно не знаем, как отправлять посылки за пределы страны. Поэтому если среди победителей окажется заграничный техписатель, мы попросим его назначить "наследника" — коллегу, родственника или друга — внутри РФ.
У нас сегодня необычный пост. В этот день ровно два года назад появился канал Техписалити!
🥳 Розыгрыш мерча!
Да-да, сейчас мы об этом расскажем.
Все эти два года мы старались делиться с вами своим опытом, наблюдениями и знаниями. А чтобы вам не было тоскливо от наших назиданий — развлекали авторскими мемами и интерактивами.
Сегодня герои нашего поста — это вы, наши дорогие подписчики. Расскажите в комментариях о том, почему вы читаете наш канал, что в нём для вас ценного. Мы приветствуем искренность, поэтому если вам что-то не нравится — тоже смело пишите. Хвалите, жалуйтесь, ругайте — до 12-00 пятницы 25 апреля.
Мы по хронологии присвоим комментариям порядковые номера, а затем с помощью онлайн-рандомайзера в прямом эфире определим победителей. Именно к ним уедут наши фирменные шоперы.
Для нас все техписатели равны, но мы честно не знаем, как отправлять посылки за пределы страны. Поэтому если среди победителей окажется заграничный техписатель, мы попросим его назначить "наследника" — коллегу, родственника или друга — внутри РФ.
❤41🎉11👍2
This media is not supported in your browser
VIEW IN TELEGRAM
Всем привет!
Будем кратки: сегодня в 13:00 по Москве разыграем тот самый деньрожденческий мерч 🎉
Присоединяйтесь к прямому эфиру или смотрите результаты в записи🎥
Присвоенные номера участников ищите вот тут.
UPD:
Итак, встречаем победителей — 20 (@Lubasha_iva), 8 (@PollyNiky), 21 (@Tinuviel_Kaoru) и 11 (@el_cortador)🥳
Спасибо всем за участие🩵
Будем кратки: сегодня в 13:00 по Москве разыграем тот самый деньрожденческий мерч 🎉
Присоединяйтесь к прямому эфиру или смотрите результаты в записи🎥
Присвоенные номера участников ищите вот тут.
UPD:
Итак, встречаем победителей — 20 (@Lubasha_iva), 8 (@PollyNiky), 21 (@Tinuviel_Kaoru) и 11 (@el_cortador)🥳
Спасибо всем за участие🩵
🔥28🎉4🦄4❤1