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

Казалось бы, с документацией всё просто — пишешь, публикуешь, поддерживаешь актуальность. Например, вот у нас в Ozon есть пользовательские инструкции на docs.ozon.ru: выглядит просто как текст на сайтике, что ж необычного-то в его размещении и в целом …

История обрастания контентом одного продукта: как мы с нуля развивали техническую документацию

Ранее я писала о том, как мы внедряли корпоративную систему управления контентом, с помощью которой удалось объединить более 200 сотрудников из разных департаментов. В этот раз расскажу непосредственно о процессе техдокументирования. Сегодня я покажу п…

Технический писатель – кто ты?

Написать данный материал меня побудила статья «Нам он и нафиг не нужон, технический писатель ваш!» (с) или для чего он вам всё-таки нужен» (далее – Статья) и он является отчасти ответом на некоторые мысли, озвученные в ней, а также содержит информацию …

«Нам он и нафиг не нужон, технический писатель ваш!» (с) или для чего он вам всё-таки нужен

Прекрасные дамы и неподражаемые господа, здравствуйте.Меня зовут Федор, я технический писатель компании «Цифровая индустриальная платформа». Это совместное предприятие ГК «Цифра» и ПАО «Газпром нефть». Скажу вам по секрету – сразу хотел вам показать в …

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

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

Как мы внедрили корпоративную CMS и с ее помощью объединили более 200 сотрудников из разных департаментов

Привет, Хабр! Меня зовут Алиса Комиссарова, я менеджер проектов в департаменте информационной поддержки Positive Technologies.Еще пять лет назад технические писатели Positive Technologies для создания руководств пользователя и прочей техдокументации ис…

CSS в Oxygen XML для гуманитариев

Всем привет!Меня зовут Татьяна и я старший технический писатель в компании Orion Innovation. В нашей уже немаленькой команде мы используем довольно обширный стэк инструментов и технологий, но наиболее востребованы и удобны в работе — XML-редакторы с по…

Можно ли избавиться от технических писателей

Согласитесь, что название статьи звучит немного странно. Зачем же избавляться от этих милых, слегка занудных, но в основном весьма безобидных людей?Как их только не называют: техписы, техрайтеры, документаторы… Хорошо, хоть не архивариусы!Если мы изб…