На момент запуска данного сайта (в начале 2021) мой опыт работы в сфере информационных технологий как-то незаметно пересёк 12-летний рубеж.
За это время довелось поработать в качестве аналитика, разработчика, консультанта, специалиста службы поддержки. Был частью команд, как на стороне подрядчика, так и заказчика. Сдавал результаты проектов и принимал их.
Основные задачи вращались вокруг разработки хранилищ данных и аналитической отчётности. Но на протяжении всего трудового пути была одна задача, на которую я никогда не обращал внимания и не придавал ей особого значения.
Эта задача - написание технической документации.
Не было у нас никогда в командах специально обученного человека, выделенного под эту конкретную задачу. Как правило, проектную документацию готовил аналитик, а за эксплуатационную отвечали непосредственно разработчики. Порой было ещё проще. Консультанты трудились над тем и другим типом документации.
Моё отношение к документации резко изменилось после окончательного перехода на сторону заказчика. В тот момент я наконец-то осознал (да, вот так неожиданно), что без качественной документации просто невозможно осуществлять поддержку системы или продукта на должном уровне. Особенно тяжело на начальном этапе после приёмки, когда только начинаешь самостоятельно разбираться с готовым продуктом.
До этого момента красиво было только на бумаге (причём проектной). При углублении в детали решения выяснялось, что в документации, которую сдавал проект, отсутствовало множество нюансов. По какой-то непонятной причине подрядчик забыл поделиться (очень хочется верить, что это было сделано не по злому умыслу) этими глубинными знаниями с товарищами из поддержки. В итоге всё сводилось к тому, что приходилось просто с чистого листа разрабатывать многие документы.
Большой вклад в становление меня, как технического писателя, внёс мой близкий друг, который по счастливой случайности стал моим наставником и непосредственным руководителем. Он привил мне свою скурпулёзность и внимание к деталям, научил писать документацию простым и доступным для целевой аудитории языком, ставить себя на место читателя.
Но всё равно в течении длительного периода времени я не ощущал себя “техническим писателем” (да я и словосочетания такого даже не слышал). Просто выполнял свою основную работу и в довесок пытался делать нашу документацию более качественной.
В один прекрасный момент я решил поискать литературу по оформлению и написанию технических документов. К моему большому удивлению, кроме ГОСТов на русском языке практически ничего и не было. Да, встретились несколько книг, но они не давали мне ответы на многие мои вопросы. Поэтому я решил посмотреть зарубежную литературу по интересующей теме.
Тут конечно было из чего выбрать. Я проглатывал одну книгу за другой. В конце каждой из них перечислялись рекомендуемые источники по техническому письму. И начиналось всё по новой.
Таким образом, я пропустил через себя огромный объём интересующей меня информации. Сразу же старался полученные знания применять на практике. Выбирал наиболее действенные техники и отбрасывал лишние. Это продолжалось достаточно долго. Но я нашёл (как мне кажется) свой стиль, который помогал мне и продолжает помогать разрабатывать понятную документацию.
Так зачем же этот сайт (или блог)?
Изначально я начал вести данный блог для самого себя, чтобы структурировать имеющиеся знания и опыт, а также собрать воедино немалое количество заметок, накопившихся после прочтения книг по техническому письму. К тому же с помощью блога я изучал некоторые инструменты и технологии, которые сейчас используют в работе многие технические писатели.
В процессе добавления материала возникло понимание, что для некоторых (конечно же потенциальных) посетителей сайта мои заметки могут стать точкой входа в удивительное ремесло на стыке технологий и литературы. Кто-то, быть может, применит представленные здесь принципы и техники в оформлении своей технической документации. А кому-то написанное здесь и вовсе покажется скучным, неинтересным и даже неправильным. Но я не претендовал и не претендую на истину в последней инстанции.
В любом случае, меня искренне радует тот факт, что представленная на сайте информация может оказаться кому-то полезной. Это мой скромный вклад в улучшение нашего мира.
С уважением,
Владимир Юсупов
Неравнодушный к документации инженер