Применение шаблонов при создании документации

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

 

Чтобы разработчики говорили на одном языке с аналитиками и тестировщиками необходимо обеспечить их общение на одном уровне детализации функционального описания продукта, необходимом для успешного выполнения проекта, а также использовать унифицированные языки моделирования, например, UML. Поскольку каждая команда работает со своими индивидуальными ограничениями и возможностями, то при изменении состава команды, необходимо адаптировать новых участников к тем условиям и особенностям постановки, которые приняты в команде.

Для этих целей используйте шаблоны документов, являющихся методологической основой вашего процесса разработки. В DEVPROM для требований и тестовых наборов вы можете создавать шаблоны страниц. Например, создайте шаблон "Вариант использования" (use case), содержащий те разделы, которые необходимо заполнить, чтобы всем участникам команды была понятна структура и ход изложения описания сценария использования.

 

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

 

Работать с шаблонами страниц очень просто. Перейдите на закладку "Требования" или "Тестирование" и выберите меню "Шаблоны". Создайте шаблон требования или раздела тестовой документации. При создании нового раздела требований, тестового набора или тестового сценария, из выпадающего списка "Шаблоны" необходимо выбрать нужный, при этом текст шаблона подставится в поле для ввода текста страницы. Вам остается лишь заполнить необходимые поля и сохранить страницу.

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