Документация

Немного про рабочее расскажу. Когда я 3 года назад пришел в компанию, в которой и тружусь по сей день, я был удивлен тем, что нет никакой документации по механизмам главной рабочей программы. От слова совсем. Небольшие инструкции были у конечных менеджеров по порядку работы, а у разработчиков ничего. Коллега предпочитал передавать информацию как в стародавние времена – из уст в уста, что называется.

Я конечно же завёл на своем компьютере базу знаний и потихоньку накидывал туда небольшие инструкции, когда было время. Делал я это не часто и за всё время работы в компании их накопилось не более 20, насколько я помню. Периодически я говорил коллеге, что не мешало бы ему, как человеку сведущему в механизмах программы, время от времени пополнять эту базу. В итоге получил от него всего пару инструкций за всё время.

Особо задумываться на эту тему не было ни желания, ни возможности, ни необходимости. Я и не думал. Вплоть до недавнего времени. И вот, наконец, я добрался до размышлений о нашей базе знаний, когда мы приняли нового сотрудника и уже я сам посвящал его в нюансы работы программы. Я чётко поймал себя на мысли, что скрупулёзная работа над составлением описаний механики работы и инструкций практически лишена смысла в контексте нашей программы. Конечно же, я расскажу почему стал так думать.

У нас в наличии 3 разработчика и сейчас на весь отдел около 300 задач (технических заданий) сформировано. Половина из разряда «было бы не плохо реализовать» и половина – «нужно реализовать». Количество это практически не уменьшается. Не потому что мы вату катаем, а потому что поступает их больше, чем мы успеваем делать. Наша информационная система изменяется практически непрерывно и то, что было актуально вчера, завтра может быть уже неактуальным.

Поэтому на текущий момент я не вижу смысла в создании описаний и инструкций. Трудозатраты, вложенные в накопление информации, к нам не возвращаются, потому что времени на это уходит порядком, а польза от этого весьма сомнительна. Быстрее устно передать эту информацию коллегам, благо мы быстро схватываем суть внесённых в программу изменений другими разработчиками.

➡️ Не думаю, что от сегодняшнего поста будет кому-то много пользы. Это скорее просто история из жизни одного программиста, нежели инструкция к действию. Я мало пишу о своей работе ввиду узкой специфики оной и небольшому интересу моих подписчиков к вопросам разработки. Поэтому спасибо всем, кто дочитал до этого места. Хорошего дня 👍.

Оригинал моего поста