Комментарии 2
Примерил статью на собственную шкуру, забавно получилось, придётся пересмотреть некоторые подходы в работе) Спасибо!
Размышления:
Работа технического писателя зависит от задачи, если он не понимает, какую задачу решает система, то результат будет плачевный.
Знание нормативной документации, как внутренней, так и внешней это база. Без этой базы получаются прекрасные технические руководства, которые при нынешнем законодательстве тов. прокурор может интерпретировать, как вещ. док для получения путевки от 3 до 7 лет в места отдаленные.
Постоянно придется изучать языки, нет не английский или немецкий, а языки на котором говорят разные специалисты и пользователи, чтобы потом не возникали в документации перлы - "мокирование данных в тестах", хотя бы потому, что 1 марта 2026 году уже прошло и правила новые.
Без хорошего инженерного образования, работать в целом можно, но тяжко, потому, что ты не понимаешь, что то, что тебе скинул технический департамент - ересь.
Поможет ли LLM техническому писателю, в целом поможет на узком спектре задач, глобально - нет.
Пример из жизни:
Задача: нужно написать ЧТЗ на группу подсистем АИС.
Ресурсы: аналитики предоставили ФТ и НФТ, технический департамент предоставил ЭД на ЦОД и интеграции, юридический департамент кинулся контрактом на разработку, в котором есть ТЗ, сроки и работы, условия приемки контракта.
Оценка сроков: Руководство - задача типовая, за неделю технический писатель напишет, руководитель проекта - точные сроки дадим через два дня, но в целом плюс-минус за неделю уложимся.
По факту: разработка заняла 2 месяца. Причина - участники процесса слабо разбираются в документации, не смотря на весь свой опыт и регалии. Как происходил процесс:
Анализ документации - неделя, выводы с такой документацией вы слоника не продадите контракт не закроете, а теперь подробнее:
НФТ не соответствует законодательству, как следствие две недели согласования и изменение формулировок.
ЭД на ЦОД и интеграции, это не документация, а записки старого гика на бабушкиных манжетах. В результате три недели на приведение сего опуса в нормальный вид. Созданная ЭД в последствии успешно прошла независимую экспертизу.
Контракт на разработку юридически грамотный, одна проблема в том, что ТЗ в нем также похоже на нормальное ТЗ, как сказки братьев Гримм на налоговый кодекс. В результате еще 2 недели на перевод ТЗ контрактного в ТЗ нормально техническое.
После чего действительно за неделю было написано ЧТЗ.
Резюме: к сожалению, многие путают работу технического писателя и работу оформителя/корректора, это разные работы и разные квалификации.
Техпис на зоне: нужна ли свобода при написании документации