Общие принципы
ТЗ – техническое задание для разработки.
ТЗ готовит проектировщик на основании ТЗК, согласованного с клиентом.
ТЗ существует для каждого приложения или отдельного решения в рамках проекта, таким образом, для одного приложения может существовать несколько ТЗ. При этом одно ТЗ может включать в себя решения по нескольким ТЗК. В случае когда, по одному приложению существует несколько ТЗ, должен быть написан сводный документ с перечислением всех ТЗ и описанием их иерархии (совместимости). Каждое ТЗ должно содержать список ТЗК, на основе которых оно реализовано.
ТЗ может иметь много версий, каждая из которых хранится в виде отдельного файла. Каждая редакция ТЗ привязана к определенной версии приложения.
ТЗ является внутренним рабочим документом компании. ТЗ должно быть написано на языке, понятном программистам, может содержать специфические термины, материал должен быть изложен с учетом принятой для "Контур предприятия" терминологии.
ТЗ содержит в себе полное описание функциональности приложения или отдельного решения в рамках приложения.
ТЗ существует и поддерживается в актуальном состоянии в течение всего срока жизни приложения.
Жизненный цикл ТЗ
Жизненный цикл ТЗ представляет собой следующую последовательность действий проектировщика:
· Разработка ТЗ:
o Получение от консультанта ТЗК.
o Разбор поставленной задачи, обсуждение с консультантом, уточнение требований.
Общение консультанта с проектировщиком проходит в форме "вопросы" – "ответы".
Результаты обсуждений должны быть зафиксированы, с учетом потраченного времени.
o Разработка диаграммы в форме ErWin, согласование диаграммы с разработкой.
o Согласование ТЗ с разработкой, определение трудоемкости и возможного срока выполнения работ по ТЗК.
o После презентации ТЗК может быть отдано на доработку, аналогичным образом будет меняться и ТЗ.
· Разработка проекта по ТЗ:
o После подписания ТЗК разработанное по нему ТЗ отдается в разработку. В процессе написания проекта программистам оказываются консультации, в результате текст ТЗ может уточняться.
Общение проектировщика с программистами проходит в форме "вопросы" – "ответы".
Результаты обсуждений должны быть зафиксированы, с учетом потраченного времени.
Если в результате разработки требуются изменения в ТЗ, ведущие к изменению ТЗК, то?????
Такое может случиться и что мы будем делать – ведь все подписано у клиента. Идти заново согласовывать и подписывать???
· Поддержка актуального состояния ТЗ:
o Проектировщик получает список требуемых изменений (уточнений) либо со стороны консультанта, либо со стороны разработки.
o Проводится аналогичное согласование решения.
Потребители ТЗ
Для работы ТЗ будут использовать:
· Консультанты:
o для тестирования решения, предоставленного разработкой;
o для разрешения вопросов к реализованному решению со стороны клиентов.
· Проектировщики:
o для тестирования решения, предоставленного разработкой;
· Тестировщики:
o для тестирования решения, предоставленного разработкой;
· Программисты:
o в качестве технического задания для реализации.
Стиль написания ТЗ
ТЗ ориентировано на программиста, который знаком с "Контур Предприятием" и применяемой технологией разработки. Документ должен быть написан лаконично и компактно, без повторов, грамматических ошибок и т.д.
ТЗ должно знакомить программиста с предметной областью задачи, но основной объем информации должен приходиться на описание работы функциональности (алгоритмы, интерфейсы, отчеты, поведение системы).
ТЗ должно занимать ориентировочно 10-30 страниц, увеличение объема документа приведет к сложностям восприятия, в таком случае необходимо разделить ТЗ на более мелкие составляющие.
Порядок написания ТЗ
ТЗ состоит из набора типовых блоков. Для разработки ТЗ предлагается использовать шаблон, представленный в файле Шаблон_ТЗ.doc.
Проектировщик для создания нового документа делает следующее:
· Переименовывает файл Шаблон_ТЗ.doc в соответствии с правилом формирования имени документа (смотри Общие_положения_ТЗК_ТЗ.doc).
· В свойствах файл заполняет поля:
o Название – название документа;
o Автор – фамилия, имя автора документа;
· Правит заполнение нижнего колонтитула:
o с левого края строка <название клиента>.<краткое название решения> меняется на значение, соответствующее ТЗ, например "ЕМР. Договоры".
o с правого края необходимо обновить поле (автотекст), содержащее имя файла.
· Формирует структуру ТЗ на основании имеющихся требований:
o оставляет пункты шаблона для описания конкретных требований к задаче;
o удаляет ненужные пункты, представленные в шаблоне,
Редактирование состава пунктов ведется с учетом обязательности и наличия требований (смотри Заполнение пунктов ТЗ и Пункты ТЗ в разрезе жизненного цикла документа).
· Добавляет по желанию на титульный лист документа оглавление.
Проектировщик при редактировании существующего документа делает следующее:
· Меняет имя файла при смене версии (смотри Общие_положения_ТЗК_ТЗ.doc).
· Изменяет описание существующих пунктов, изменения выделяются.
· Прописывает дополнительные пункты в соответствии со стандартом структуры ТЗ, изменения выделяются.
· Заполняет пункт "Изменения версий", вне зависимости от смены версии документа.
· Обновляет оглавление.
Пункты ТЗ в разрезе жизненного цикла документа
В разрезе жизненного цикла ТЗ пункты делятся следующим образом:
1. пункты, обязательные для формирования в первом варианте;
2. пункты, обязательные для формирования при наличии блока функциональности или информации для отражения в документе.
В первый список попадают пункты:
· Название;
· Шапка;
· Оглавление;
· Введение, Описание задачи;
· Изменения версий.
Все остальные во второй список.
Заполнение пунктов ТЗ
ТЗ как документ представляет собой набор пунктов, которые заполняются стандартным образом для различных задач. Подробное описание содержимого блоков документа описывается в соответствующих инструкциях. Ниже представлено краткое описание содержимого ТЗ.
Название - название ТЗК, отражающее суть описываемого решения.
Шапка - блок для подписей консультанта и представителя клиента.
Оглавление - состав пунктов документа, формируется при помощи стандартного механизма Word.
Введение - описание задачи, решаемой при помощи проекта ТЗК.
Описание задачи - краткое описание предметной области задачи, позволяющей разработчику представить решаемую проблему,
Описание бизнес-процесса клиента (блок-схема) – формирование блок-схемы аналогично ТЗК, пункт может содержать в себе ссылку на описание блок-схемы в ТЗК, может содержать описанием бизнес-процесса, соответствующего нескольким ТЗК.
Реализация -
ErWin - диаграмма - ссылка на файл с ErWin диаграммой.
Объекты системы - список новых \ изменяемых объектов системы,
по каждому новому объекту указывается:
· его назначение;
· список атрибутов с указанием алгоритма заполнения;
· порядок ввода данных объекта системы – возможные варианты: указание существующего интерфейса, ссылка на пункт ТЗ с описанием интерфейса.
по каждому изменяемомуобъекту указывается:
· в названии пункта ТЗ уточнение, что это изменение существующего объекта;
· список измененных атрибутов с указанием алгоритма заполнения;
· изменения в порядке ввода данных объекта системы – возможные варианты: указание существующего интерфейса, ссылка на пункт ТЗ с описанием интерфейса.
Документы - список новых \ изменяемых документов,
по каждому новому документу указывается:
· его назначение;
· список атрибутов с указанием алгоритма заполнения;
· список атрибутов спецификации с указанием алгоритма заполнения;
· участники;
· дополнительная аналитика;
· связи между документами;
· порядок ввода данных документа – возможные варианты: указание существующего интерфейса, ссылка на пункт ТЗ с описанием интерфейса.
по каждому изменяемомуобъекту указывается:
· в названии пункта ТЗ уточнение, что это изменение существующего объекта;
· список измененных атрибутов с указанием алгоритма заполнения;
· список измененных атрибутов спецификации с указанием алгоритма заполнения;
· изменения в участниках;
· изменения в дополнительной аналитике;
· изменения в связях между документами;
· изменения в порядке ввода данных документа – возможные варианты: указание существующего интерфейса, ссылка на пункт ТЗ с описанием интерфейса.
Интерфейсы - список новых \ изменяемых интерфейсов, по каждому интерфейсу указывается:
· его назначение;
· условия запуска (пункт меню, форма, процесс);
· параметры;
· форма – в данном пункте необходимо приложить предполагаемый вид интерфейса;
· поля - построение выборки данных, алгоритмы заполнения полей;
· порядок работы – все последовательности "воздействие - реакция", как то: нажатия на кнопки, пересчеты значений, заполнение связанных значений,
в данном пункте могут быть ссылки на пункты ТЗ с описание процедур;
· проверки при сохранении данных в интерфейсе.
Процедуры - список новых \ изменяемых процедур, по каждой процедуре указывается:
· его назначение;
· условия запуска (пункт меню, форма, процесс);
· параметры;
· порядок работы – алгоритм работы.
Отчеты - список новых \ изменяемых отчетов, по каждому отчету указывается:
· его назначение;
· условия запуска (пункт меню, форма, процесс);
· параметры;
· форма - должна быть приложена форма отчета, варианты представления: пример непосредственно в файле ТЗК, ссылка в ТЗК на дополнительные файлы Word, Excel;
· поля - построение выборки данных, алгоритмы заполнения полей;
Olap - отчеты - список новых \ изменяемых olap- отчетов, по каждому olap -отчету указывается:
· его назначение;
· условия запуска (пункт меню, форма, процесс);
· параметры;
· выборка;
· разрезы;
· факты;
· грид, вызываемый из ячейки.
Технология работы – отражаемая информация аналогична ТЗК, пункт может содержать в себе ссылку на пункты ТЗК, может содержать общее описанием технологии и особенностей работы, соответствующим нескольким ТЗК.
Приложения -
Словарь терминов и определений - таблица, содержащая список терминов и определений, используемых в данном документе,
заполняется, когда в тексте встречаются специфические термины или повторяющиеся определения, требующие пояснения к смыслу или методу формирования, получения.
в случае, когда по одному приложению существует несколько ТЗ, этот пункт может быть вынесен в сводный документ.
Список вопросов - список всех известных в рамках данного документа нерешенных проблем, предложений по развитию задачи, отложенных решений, делится на подпункты "Предложение" и "Отложенная задача".
Список ТЗК - таблица, содержащая список ТЗК, на основание которых разработано ТЗ.
Изменения версий - таблица, содержащая список изменений, внесенных в течение жизненного цикла документа.
Критерии качества ТЗ
Качество ТЗ определяется по следующим критериям:
· Соответствие ТЗ стандартной структуре – качественный критерий, по которому руководитель консультанта оценивает соответствие оформления ТЗ стандарту. Предлагаются оценки:
o 1– соответствует стандарту;
o 2 – не соответствует стандарту.
· Срок согласования ТЗ – при возникновении потребности формирования ТЗ определяется плановый срок подготовки ТЗ. Далее оценивается соответствие срока исполнения ТЗК плановому сроку. Предлагаются оценки:
o 1 – выполнено в срок;
o 2 – допустимая сдвижка срока;
o 3 – выполнено с недопустимой задержкой.
· Трудоемкость согласования требований – количественный критерий, позволяющий оценить время, затраченное программистом на формулировку вопросов, позволяющих уточнить суть задачи и количество таких вопросов. Для формирования оценок требуется статистика. Основой послужат данные о результатах обсуждения, собранные в период уточнения требований и разработки приложения (смотри пункт "Жизненный цикл ТЗ ").