Пишем техническое задание
17.11.2014
Любая работа начинается с задания, а работа технического писателя должна начинаться с технического задания. Осталось только разобраться, что это такое и зачем оно нам нужно. Прочитайте статью Кимберли Чан, чтобы не попасть в такую же ситуацию, как разработчик из уже любимой нами серии комиксов.
Специалисты компании «ПроТекст» будут рады разработать техническое задание для Вашей компании с учётом всех нюансов. Подробности на этой странице.
Что такое техническое задание на разработку программного обеспечения?
Большинство разработчиков предпочитают работать с техническим заданием на разработку программного обеспечения, так как этот документ обычно содержит следующее:
- Полное описание целей и функциональности программного обеспечения;
- Детали того, как программа будет работать с точки зрения скорости, времени отклика, доступности, мобильности, надёжности, скорости восстановления и т.д.;
- Варианты того, как пользователи будут использовать программное обеспечение;
- Определение того, как приложение будет взаимодействовать с оборудованием или другими программами;
- Нефункциональные требования (например: требования к обеспечению эффективности, стандарты качества, или проектные ограничения)
Почему это важно?
ТЗ позволяет разработчикам ясно понять цели программного обеспечения и то, на чём нужно фокусироваться. Кроме того, оно:
- Экономит время на коммуникации;
- Минимизирует трудоёмкость разработки;
- Позволяет давать клиентам обратную связь;
- Помогает избежать дублирования задач;
- Способствует переходу к новым пользователям или новым машинам;
- Разбивает проблему на части;
- Служит в качестве основного документа для проверки процессов тестирования и валидации;
- Отсылка к последним техническим заданиям помогает выявить неточности и технологические недостатки.
Как написать ТЗ на разработку программного обеспечения?
Нет стандартного метода написания ТЗ, но мы можем дать несколько советов:
Создайте схему
Если у вас ещё нет шаблона, их можно найти в Интернете. Используйте шаблон для создания плана документа. Измените его в соответствии с потребностями вашей организации.
Планы технических заданий различаются в зависимости от организации и её процессов. Некоторые из них могут быть простыми, другие являются более подробными и сложными.
Вот пример простого плана ТЗ на ПО:
- Цель
- Сфера применения
- Обзор системы
- Ссылки
- Определения
- Примеры использования
- Функциональные требования
- Нефункциональные требования
После создания плана можно писать спецификацию. Вот несколько советов:
Выберите для написания лучшего
Писатель должен иметь превосходные коммуникационные навыки. Цель спецификации в том, чтобы её мог понять каждый. Всё, что остается неясным или недопонятым, может привести к не особо приятным последствиям. Многие предполагают, что участие в процессе технического писателя помогает предотвратить непонимание. Есть писатели, более опытные, чем разработчики, с талантом вносить точность и ясность. Технические писатели знают, как собирать и обрабатывать нужную информацию; они также знают, как донести требования заказчика.
Сделайте информацию визуальной
Изображение может сэкономить 1000 слов. Включите визуальную информацию, например, таблицы и графики, чтобы лучше донести идеи.
Не документируйте слишком много
Старайтесь не включать в документ пункты, которые не нужно документировать. ТЗ может стать слишком длинным, поэтому избегайте лишней информации.
Создайте онлайн-версию ТЗ и постоянно обновляйте её
По мере выполнения задач или если произошли изменения в штате или процессах, ТЗ необходимо будет обновлять. По этой причине сохраняйте виртуальную версию – это поможет убедиться, что вся команда при любом изменении получит обновлённый документ.
Источник: Writing a Software Requirements Specification Document
Тэги: советы, технические задания
