Инструменты создания проектной документации

06.10.2009 15:41

Многие проектные команды использует MS Word для создания проектной документации. Это происходит по нескольким причинам, в частности из-за того, что этим инструментом уже давно овладели практически все пользователи ПК. Однако, мало кто задумывается, что тем самым команда загоняет себя в тупик, из которого практически нет выхода. Вот только некоторые основные ограничения, которые накладывает MS Word на документацию:

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

Интернет сообщество уже давно придумало способ как сделать совместное редактирование текстовой информации удобным и контролируемым - это использование Wiki. Вот основные преимущества, которые получают пользователи Wiki:

  • текстовый формат - любые документы или разделы в Wiki - это текст с простой разметкой, который можно выгрузить в произвольный формат и эффективно отслеживать изменения, путем использования подходящего инструментария. Возможности разметки Wiki часто ограничены по сравнению с возможностями MS Word или других текстовых процессоров, однако, это позволяет автору сосредоточиться на содержании и не отвлекаться на стилистические задачи, что важно для экономии проектного времени.
  • гипертекст - в Wiki вы используете всю мощь гипертекста и можете ссылаться на любой раздел, на любой документ или внешний источник путем простого указания ссылки, причем эта ссылка будет всегда актуальной, пока живет данный документ.
  • прозрачный доступ - поскольку Wiki это web-решение, то вам не нужно засорять свою голову файловой иерархией и ПК, размещенными в сети, как вы это делаете при работе с MS Word документами. Вы знаете только об одной точке входа в Wiki - это адрес в строке браузера, все остальное где-то живет на своих серверах и работает, но вы этом и не задумываетесь.

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

Очевидно, что проектная документация гораздо лучше ложится в концепцию Сети и гипертекста, нежели в концепцию файловой системы. В системе управления распределенными проектам DEVPROM работа с текстовой документацией построена на базе Wiki, что позволяет вам максимально эффективно создавать и поддерживать проектную документацию, контролировать изменения, связывать различные документы между собой, а также вести обсуждение по каждому разделу документа с участием всей команды проекта.

Подробнее о возможностях Wiki, используемой в DEVPROM читайте в Руководстве пользователя.

Еще интересные статьи на эту тему: