Операция выполнена!
Закрыть
Хабы: Блог компании РТЛабс, Подготовка технической документации

Документацию не читают? Увы, но это действительно так. Достаточно вспомнить своё типичное поведение при покупке нового прибора: сначала включим в сеть, а уже когда не заработает, прочтём инструкцию.
Давайте вместе разберёмся, почему так происходит и что с этим делать.
Я — Мария Киселёва, начальник отдела разработки технической документации в РТЛабс. 12 лет в технической документации научили меня, что хороший текст начинается не с красивых слов, а с жёстких договорённостей. Глоссарии, стайлгайды, шаблоны и отказ от двусмысленности — без этого любая инструкция превращается в «письмо из Простоквашино»: то лапы ломит, то хвост отваливается :)

В статье разберу четыре злейших врага понятной документации и покажу на реальных примерах, как заставить их работать на вас.

Читать далее
Читайте также
НОВОСТИ

ПИШИТЕ

Техническая поддержка проекта ВсеТут

info@vsetut.pro