технический писатель

  • ХабрахабрФото [Перевод] Как эффективно добавлять документацию при разработке продукта?

    [Перевод] Как эффективно добавлять документацию при разработке продукта?

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

    Читать далее »
  • ХабрахабрФото Делаем документацию здорового человека в Git на примере Docs Ozon

    Делаем документацию здорового человека в Git на примере Docs Ozon

    Привет! Это Катя из Ozon — руководитель отдела техписателей. Сегодня буду рассказывать:  как и зачем менять Confluence на статический генератор сайтов;  зачем техписателям знать git и CI/CD;  в какой момент пора искать разработчиков и превращать простое размещение статеек в платформу документации. Дисклеймер В разных компаниях и даже в разных командах люди с одними и теми же названиями должностей могут заниматься разными…

    Читать далее »
  • ХабрахабрФото Туда — не знаю куда и как. Что делать, если вашей компании нужно поменять основной инструментарий

    Туда — не знаю куда и как. Что делать, если вашей компании нужно поменять основной инструментарий

    Ситуация, когда компания враз лишается привычных сервисов и нужно срочно менять технический функционал, нынче крайне актуальна. Причем не поймешь, как проще: когда «партия сказала “надо”» и «срок — вчера» или когда цейтнота нет, но зато нужно доказать руководителю необходимость замены и уговорить всех участников миграции. Меня зовут Алла Царьгородская, я — руководитель группы разработки технической документации в «Лаборатории Касперского». Сегодня…

    Читать далее »
  • ХабрахабрФото Почему пользователи не читают документацию или как можно улучшить руководство пользователя

    Почему пользователи не читают документацию или как можно улучшить руководство пользователя

    Часть первая Данная статья не предполагает каких-то заумных и крайне неочевидных советов по написанию и проверке технической документации. Многие из перечисленных «советов» многим покажутся очевидными, но из раза в раз, анализируя документацию наших пользователей, мы сталкиваемся с одними и теми же банальными ошибками, которые чаще всего происходят из-за фактора «забыл». Так что данный пост можно расценить как памятку не техническому…

    Читать далее »
  • ХабрахабрФото Что должно быть в базе знаний, чтобы всем было хорошо

    Что должно быть в базе знаний, чтобы всем было хорошо

    Привет, Хабр! Я Катя из команды техписателей в Ozon. Мы продолжаем расти и развиваться, поэтому вслед за статьёй о видах документации хочу разобрать, какие проблемы внутри команды можно документацией решить. Если вы из команды, у которой нет ни документации, ни технического писателя, но паучье чутьё подсказывает, что беда близко и предотвратить её можно именно качественной докой, — в этой статье…

    Читать далее »
  • ХабрахабрФото Как писать хорошую документацию

    Как писать хорошую документацию

    Несколько лет назад я услышал от одного коллеги историю. Он в то время работал начальником отдела технической документации в IT компании. Дело было на собрании, посвященном знакомству с новым техническим директором. Тот, пожав моему коллеге руку и узнав о его роли, пошутил: “Документация? Так ее же не читает никто! Двадцать первый век на дворе”. Вряд ли кому-то из нас было…

    Читать далее »
  • ХабрахабрФото Почему из команды уходит техписатель? У меня на это 5 причин

    Почему из команды уходит техписатель? У меня на это 5 причин

    Источник: ru.freepik.com Наличие технического писателя в команде воспринимается либо как нечто само собой разумеющееся, либо как нечто вызывающее вопросы “Ты кто? Ты что тут делаешь?”. Но когда технический писатель уходит из команды, его отсутствие можно сравнить с отсутствием маленького кусочка в большом и сложном паззле. Без этого кусочка можно обойтись. Но внимательный наблюдатель заметит, что картина команда не полная, в…

    Читать далее »
  • ХабрахабрФото Внешний вид и скриншоты в пользовательской документации. Как надо и не надо делать

    Внешний вид и скриншоты в пользовательской документации. Как надо и не надо делать

    Люди читают пользовательскую документацию, когда самостоятельно не могут с чем-то разобраться. Они не делают это для развлечения. И эмоции, которые преобладают в этот момент, далеко не всегда позитивные. Как разработчик пользовательской документации может помочь пользователю? Что ему необходимо учитывать при написании документа? Разработчику документации надо всего лишь написать эффективный документ и разместить его в открытом доступе. Казалось бы ничего сложного,…

    Читать далее »
  • ХабрахабрФото [Из песочницы] Техническая документация в разработке ПО: кто, зачем, когда и как описывает проект

    [Из песочницы] Техническая документация в разработке ПО: кто, зачем, когда и как описывает проект

    Привет! Меня зовут Даша Григорьева, я технический писатель в компании 65apps. Мы занимаемся разработкой сложных мобильных решений, и моя задача — подготовка технической документации по проектам. Очень часто роль технического писателя бывает недооцененной в компании (не у нас, конечно). Поэтому я хочу рассказать, зачем компании-разработчику нужен такой специалист, что такое технический проект, чем он отличается от ТЗ и почему это…

    Читать далее »
  • ХабрахабрФото К чему приложить прикладного лингвиста?

    К чему приложить прикладного лингвиста?

    Это многих славных путь.”Н.А. “Что за дело? Некрасов Всем привет! О том, как у меня это вышло, я и хочу рассказать. Меня зовут Карина, и я “совместитель” — совмещаю учёбу в магистратуре и работу технического писателя в Veeam Software. Заодно кто-то узнает, как можно прийти в эту профессию, и какие я вижу для себя плюсы и минусы в работе во…

    Читать далее »


Кнопка «Наверх»