Инструкция (для тех, кто пишет документацию)
(Дисклеймер: Пост содержит исключительно профессиональную иронию. Автор настоятельно рекомендует не следовать советам, обозначенным в околостихотворной форме и делать всё ровно наоборот!)
Коль в твоей IT-команде Дали в срок тебе задание Инструктаж для техподдержки И для юзеров писать - Подойди ты к делу творчески, Чтобы каждый, кто посмотрит, Захотел немедля выпить Валерьянки капель пять.
Совет №1: Интригуйте
Если сделал разработчик Очень сложную фичу, Не ходи к нему с вопросом, В код и носа ты не суй. Напиши, что «всё работает», И добавь: «нажми на эту». Пусть читатель сам гадает, Что за «ту» имел в виду.
Совет №2: Масштабируйте
Если надобен скриншотик - Ты снимай давай масштабно: Пусть на фото будет почта, Вкладка с котиками, чат. Кнопка там в углу таится? Пусть! Ведь поиск интересен. Кто найдет её за месяц - Тот действительно эксперт.
Совет №3: Обучайте
Слов простых не выбирай ты - Это скучно и банально. «Бизнес-логика», «дискретность», “Кэш” и “Cookie”, иже с ним. Пусть в поддержке все рыдают, Чувствуя свое паденье. Знание - конечно сила, Но не для средних умов.
СТОП! Советов можно накидать еще целую кучу (и ваши я буду ждать в комментариях), но в каждой такой иронии - боль отдельно взятого специалиста, составляющего Базу Знаний, и тех, кто потом с ней (или ее отсутствием) вынужден работать. Документация стоит миллионов, только вот хорошая - прибыли, а плохая - убытков.
Элементов понятной статьи очень много, но можем начать хотя бы с этих:
✅ Скриншот с красной рамкой (только то, что нужно). ✅ Текст, понятный даже стажеру в первый день. ✅ Регулярная чистка «legacy-мусора». А какой самый странный «совет» в инструкциях встречали вы? Поделитесь в комментариях.
· 19.05
вот что заметил, документация может быть настоящей пыткой для разработчиков. когда писал свои инструкции, старался избегать заумных терминов, но иногда все равно получалось. а недавно настроил авто-отклики через jobpath, так это сэкономило кучу времени, и теперь у меня больше сил на качественную документацию. честно, лучше бы вообще ничего не писать, чем оставлять неясности.
0
ответить
коммент скрыт — часть юзеров считает его токсичным или некорректным
коммент удалён