Что я узнал, будучи техническим писателем в IT компании
Тебя никогда в жизни не позовут на совещания о новом релизе. А зачем? Мало ли, что он там услышит. Проще рассказать ему о функции, когда осталось две недели до дедлайна.
Ты последнее звено в цепи IT процессов. Все считают нормальным выдать рабочий стенд писателям за пару дней до релиза. Если ты там что-то сломал, все косяки свалятся на тебя.
Ты всегда и от всех зависим. Нужно узнать работу методов или параметров? Иди по линии: начальник, какой-то тестировщик, какой-то программист, потом архитектор, который уже забыл, как это было сделано, и он тебя переправляет к тому же тестировщику. Круг замкнулся.
Никто из пользователей софта тебя никогда не похвалит. Хвалебные отзывы о документации никто не пишет.
Написал инструкцию по шагам. Кто будет верифицировать? Никто. Все отнекиваются. Нашёлся один сердобольный программист, который сидит после окончания рабочего дня. Он тебе подскажет, что и как.
Тестирование документации как этап в регламенте QA? Круто, если есть. Обычно нет.
Приходит высокий начальник и жалуется на качество документации. Спрашиваешь, а был ли тикет и кто спросил? Оказывается, это его бабушка пожаловалась, которая не ту кнопку нажала.
Пишешь саппорту. Присылайте проблемы с тем, с чем столкнулся человек. Я отражу это в документации. Оказывается, что всё уже отражено. А сам саппорт не знает документацию.
Начальник спрашивает: а чем ты весь день занимался? Почему нет артефактов труда? Да я, блядь, весь день пытался понять, почему эта херь не работает, которую мне отдали, обошёл десять человек, они подтвердили, что не работает.
Нельзя оценивать технических писателей по количеству знаков или строчек, написанных в день. Но всё ещё существуют такие начальники.
Хороший писатель выполняет функции тестировщика, работника поддержки и пользователя, что самое главное. Иногда и программиста. У меня был момент, когда я должен был сдать документацию на не существующую функцию, и я описал её сам, как думаю, она должна работать. Это приняли. И в итоге программисты такие, ну нам теперь придётся так сделать, как он описал.
Даже если ясность твоего объяснения исключает ложное понимание, всё равно кто-то поймёт тебя неправильно.