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

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

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

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

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

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

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

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

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

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

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

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

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

При работе над любым проектом, помимо запланированных на итерацию задач, возникает потребность как-то хранить список мелких, но важных личных задач - делаются они, как правило, в моменты "отдыха" от основных проектных активностей.

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

Чтобы быть уверенным, что каждая такая задача будет выполнена, мы придумали хранить персональные списки дел на главной странице проекта в системе управления проектами DEVPROM. Таким образом, и так уже работая над проектом каждый день с DEVPROM, вы еще получаете возможность вести свой персональный TODO list.

Теперь каждый участник проектной команды может практически мгновенно добавлять и отмечать выполненными свои небольшие, но не менее важные проектные задачи - для этого достаточно только ввести название задачи и нажать кнопку Сохранить.

Ваши персональные задачи никак не участвуют ни в плане проекта, ни в отчетности, а так же они недоступны никому, кроме вас.

Попробуйте, и вы убедитесь, что это действительно удобно!

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

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

В системе управления проектами DEVPROM такая проблема сведена к минимуму - все артефакты проекта хранятся в системе управления проектами, которая является единой точкой доступа к абсолютно всей проектной информации.

Если вы не помните точного названия файла, но знаете какую-либо часть его названия или описания - вы сможете быстро найти требуемый файл через поиск в системе.

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

Если файл более не актуален, но вы не хотите его удалять, чтобы сохранить историю - просто перенесите его в архив. Файл перестанет отображаться на основной закладке Артефакты, но будет по прежнему доступен в ее архивном разделе.

Если вы хотите сделать какие-либо файлы доступными внешним участникам проекта - поместите их в отдельную папку и отметьте, что она является общедоступной. В этом случае внешние пользователи, не являющиеся участниками вашей проектной команды, смогут получить readonly доступ к опубликованным файлам.

Мы выходим в Twitter, присоединяйтесь!

Все самые свежие анонсы по развитию проекта и много других интересных заметок :)

На связи!

Команда DEVPROM