[История разработчика SI] 10. Что такое документирование в проектах SI?

История разработчика SI
#10. Что такое документирование в проектах SI?

В проектах SI необходимо предоставлять заказчику документацию в качестве доказательства успешной реализации проекта.

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

Во время составления документации иногда возникают мысли: «Неужели я стал разработчиком, чтобы заниматься этим? Может, я всё-таки офисный работник?». Кроме того, в России часто бывает так, что документирование по этапам выполняется в последний момент перед завершением проекта. Причин тому несколько:

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

Как ни странно, несмотря на неправильный порядок действий, это стало естественным способом работы в российской культуре SI.

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

Обычно разработчики относятся к составлению документации с отвращением, но что поделать, вы же новичок.

Наиболее уязвимыми оказываются стажёры, которым поручается составление документации. Поскольку сразу доверить им разработку не могут, поручают составление документации.

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