Документацию можно готовить где угодно и как угодно. Писать инструкции в многочисленных CCMS, публиковать сайты через генераторы наподобие Sphinx, применять сложные разметки вроде DITA, вести базы знаний в Confluence или вообще собирать файлы в Word. У каждого инструмента и подхода есть свои плюсы и минусы. Выбор зависит от множества факторов: сложности, требований к результату, потребителя контента, бюджета отдела, объема накопившегося легаси — да и просто моды в профессиональной среде.

Но что если посмотреть на вопрос с другой стороны? Что если выбирать и проектировать систему документирования исходя из того, сколько свободы предоставляется техническому писателю?

Давайте выкрутим регулятор свободы на максималку сначала в одну сторону, когда техпис не имеет абсолютно никаких рамок и ограничений, а затем в противоположную, когда он тотально несвободен. Какие преимущества будут у каждой из этих двух крайностей и какие выводы можно будет сделать по итогу такого мысленного эксперимента — об этом моя статья.

Несмотря на длинную историю, профессия технического писателя в массовом сознании так и не закрепилась. Если ты техпис, то наверняка сталкивался с необходимостью объяснять родным, соседям по гаражу и терапевту о том, что это за зверь такой. Я, например, в какой‑то момент махнул рукой и на вопрос о том, кем ты работаешь, отвечаю: пишу руководства пользователя к программному обеспечению. Длинновато, зато так меня понимают сразу.

Причины безвестности техписов связаны в том числе с их нерепрезентативностью в поп‑культуре. Визуально разработка документов не отличается от печатания по клавиатуре, а на того, кто это делает, не напялишь камуфляж, белый халат или иную спецодежду. Взять, к примеру, программистов. Они тоже работают за компьютером, но их труд сопровождают бегущий водопад строчек с зелеными письменами на черном фоне и эффектный интерфейс IDE‑шки. Да и вообще, в кино создатели софта меняют своим кодом мир, вершат судьбы. Короче, их труд не только добавляет жира картинке, но и привносит в сюжет захватывающие перспективы. (И это я еще не говорю про хакеров.) Написание же документации считывается обывателем как ответвление бюрократии. Лучше уж тогда Кафку экранизировать.

Поэтому можно было бы предположить, что техписатели в киноискусстве отсутствуют как класс. И я тоже так думал. Однако, покопавшись в теме, обнаружил, что кое‑какое игровое кино сняли и про наш народ.