Как правильно составить техзадание. Основные рекомендации. Как писать техническое задание?! Как написать техзадание

Главная / Квартира

В жизни очень часто бывает так, что человек не может объяснить, что хочет, даже в бытовых вещах. Когда дело доходит до объяснения программисту своих «хотелок», человек просто впадает в ступор.

В идеале ТЗ должен составлять заказчик — только он знает, что ему нужно. Но на практике из-за низкой компетенции заказчика в сфере 1С часто это приходится делать исполнителю. Заказчик устно озвучивает свои потребности, а программист(консультант) оформляет это в письменной форме.

Зачем нужно техническое задание?

Любые , в идеале, должны сопровождаться техническим заданием. Это, во-первых, четкое определение задачи, сроков и метода выполнения. Во-вторых, это документ, с помощью которого решаются все спорные моменты в будущем. Писать ТЗ или нет — дело, конечно, Ваше, лично мне ТЗ облегчает работу и общение с клиентом.

Получите 267 видеоуроков по 1С бесплатно:

Что должно содержать в себе техническое задание?

Тех. задание обязательно должно содержать в себе:

  • цель — задача, которую мы решим, реализуя данное ТЗ;
  • описание — краткое изложение предстоящих доработок;
  • способ реализации — подробное описание методов решения цели. В этом пункте необходимо описать все нюансы задачи на языке программиста: какие , создаем/редактируем, как должен выглядеть интерфейс и т.д. Если Вы не владеете «языком программиста», но «что-то слышали», лучше не пытаться писать на техническом языке — получается достаточно весело. Описание должно быть однозначным и не вызывать вопросов. Также может содержать в себе пример реализации подобного решения в другой сфере;
  • оценка работы — очень важный пункт, описание трудозатрат.

Также существуют государственные стандарты к написанию ТЗ — ГОСТы. На практике мало где применяются, но бывает, заказчик настаивает на этом.

По опыту, при сдаче работ очень часто возникают ситуации вроде «а мы Вам тогда-то говорили же…», что не очень приятно, и зачастую приходится переделывать работу целиком. Поэтому хорошо написанное ТЗ сильно облегчает жизнь обеих сторон.

Примеры и образцы ТЗ для 1С

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

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

Техническое задание (далее – ТЗ) является основой договора между заказчиком и исполнителем на проведение проектных или иных работ (далее – договор), определяет цели, задачи, порядок и условия работ, ожидаемые результаты и сроки их выполнения. Техническое задание устанавливает основное назначение разрабатываемого объекта, его технические характеристики, показатели качества и технико-экономические требования, предписание по выполнению необходимых стадий создания документации (конструкторской, технологической, программной и других) и ее состав, а также специальные требования. Любые изменения, дополнения и уточнения формулировок ТЗ должны быть согласованы с заказчиком и утверждены им.

Конечно, разработкой и составлением ТЗ занимаются ведущие специалисты – главные конструкторы, руководители проектов и работ. Однако оформление этого документа может быть поручено секретарю или другому работнику, ответственному за делопроизводство в организации или структурном подразделении.

Нормативная база

Основными нормативными документами, регламентирующими правила подготовки и оформления ТЗ, являются:

  • межгосударственный стандарт ГОСТ 34.602-89 «Информационная технология. Комплекс стандартов на автоматизированные системы. Техническое задание на создание автоматизированной системы» (далее – ГОСТ 34.602-89), который распространяется на автоматизированные системы для автоматизации различных видов деятельности (управление, проектирование, исследование и т.п.), включая их сочетания, и устанавливает состав, содержание, правила оформления документа «Техническое задание на создание (развитие или модернизацию) системы»;
  • государственный стандарт ГОСТ 19.201-78 «Единая система программной документации. Техническое задание. Требования к содержанию и оформлению» (далее – ГОСТ 19.201-78). Стандарт устанавливает порядок построения и оформления ТЗ на разработку программы или программного изделия для вычислительных машин, комплексов и систем независимо от их назначения и области применения.

ГОСТ 34.602-89 предназначен для разработчиков автоматизированных систем, ГОСТ 19.201-78 – для разработчиков программных средств.

Обратите внимание! Согласно п. 1 ст. 46 Федерального закона от 27.12.2002 № 184-ФЗ «О техническом регулировании» (в ред. от 03.12.2012) со дня вступления в силу данного закона впредь до вступления в силу соответствующих технических регламентов требования к продукции или к продукции и связанным с требованиями к продукции процессам проектирования (включая изыскания), производства, строительства, монтажа, наладки, эксплуатации, хранения, перевозки, реализации и утилизации, установленные нормативными правовыми актами Российской Федерации и нормативными документами федеральных органов исполнительной власти, носят рекомендательный характер и подлежат обязательному исполнению только в части, соответствующей целям:

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

В этой статье мы рассмотрим правила оформления технического задания на автоматизированную систему (далее – ТЗ на АС). Согласно п. 1.1 ГОСТ 34.602-89 ТЗ на АС является основным документом , определяющим требования и порядок создания, развития или модернизации автоматизированной системы, в соответствии с которым проводится разработка системы и ее приемка при вводе в действие.

Состав ТЗ на АС

Согласно п. 2.1 ГОСТ 34.602-89 ТЗ на АС содержит следующие разделы, которые могут быть разделены на подразделы:

  • общие сведения;
  • назначение и цели создания (развития) системы;
  • характеристика объектов автоматизации;
  • требования к системе;
  • состав и содержание работ по созданию системы;
  • порядок контроля и приемки системы;
  • требования к составу и содержанию работ по подготовке объекта автоматизации к вводу системы в действие;
  • требования к документированию;
  • источники разработки.

В ТЗ на АС могут включаться приложения.

Правила оформления ТЗ на АС по ГОСТ 34.602-89

Правилам оформления ТЗ на АС в ГОСТ 34.602-89 посвящен небольшой раздел, в котором даны указания по правилам нумерации листов, оформления титульного листа и дополнений к документу.

Нумерация листов ТЗ. Номера листов (страниц) проставляют, начиная с первого листа, следующего за титульным, в верхней части листа (над текстом, посередине) после обозначения кода ТЗ на АС.

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

При необходимости на титульном листе ТЗ на АС допускается помещать установленные в отрасли коды, например: гриф секретности, код работы, регистрационный номер ТЗ и др.

Форма титульного листа ТЗ на АС приведена в Приложении 2 к ГОСТ 34.602-89 (Пример 1).

Пример 1

Форма титульного листа ТЗ на АС

______________________________________________________.

наименование организации – разработчика ТЗ на АС

УТВЕРЖДАЮ

Руководитель (должность, наименование предприятия – заказчика АС)

УТВЕРЖДАЮ

Руководитель (должность, наименование предприятия – разработчика АС)

Личная подпись Расшифровка подписи

наименование вида АС

________________________________________________________

наименование объекта автоматизации

________________________________________________________

сокращенное наименование АС

ТЕХНИЧЕСКОЕ ЗАДАНИЕ

На ____ листах

Действует с

СОГЛАСОВАНО

Руководитель (должность, наименование согласующей организации)

Личная подпись Расшифровка подписи

Титульный лист дополнения к ТЗ на АС оформляют аналогично титульному листу ТЗ. Вместо наименования «Техническое задание» пишут «Дополнение № ... к ТЗ на АС...».

Оформление последнего листа ТЗ на АС. Форма последнего листа ТЗ на АС, на котором помещают подписи разработчиков и должностных лиц, участвующих в согласовании и рассмотрении проекта ТЗ на АС, приведена в Приложении 3 к ГОСТ 34.602-89 (Пример 2).

Пример 2

Форма последнего листа ТЗ на АС

_________________________________________

(код ТЗ)

СОСТАВИЛИ

Должность исполнителя

Фамилия, имя, отчество






СОГЛАСОВАНО

Наименование организации, предприятия

Должность

Фамилия, имя, отчество






Согласно п. 3.2 ГОСТ 34.602-89 ТЗ на АС оформляется в соответствии с требованиями межгосударственного стандарта ГОСТ 2.105-95 «Единая система конструкторской документации . Общие требования к текстовым документам», устанавливающего общие требования к выполнению текстовых документов на изделия машиностроения, приборостроения и строительства.

Правила оформления текстовой части ТЗ на АС по ГОСТ 2.105-95

Согласно п. 3.1 ГОСТ 2.105-95 текстовые документы подразделяют на документы, содержащие, в основном, сплошной текст (технические условия, паспорта, расчеты, пояснительные записки, инструкции и т.п.), и документы, содержащие текст, разбитый на графы (спецификации, ведомости, таблицы и т.п.). Текстовые документы выполняют в бумажной форме и (или) в форме электронного документа.

Допускается в текстовых документах, содержащих текст, разбитый на графы, использовать сокращения слов по ГОСТ 2.316-2008 «ЕСКД. Правила нанесения надписей, технических требований и таблиц на графических документах. Общие положения».

Требования к текстовым документам, содержащим в основном сплошной текст, подробно изложены в четвертом разделе ГОСТ 2.105-95. Рассмотрим основные положения этого раздела.

Построение документа. В п. 4.1 ГОСТ 2.105-95 приведены подробные инструкции по нумерации и расположению разделов, подразделов, пунктов и подпунктов.

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

Разделы, как и подразделы, могут состоять из одного или нескольких пунктов.

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

Если раздел или подраздел состоит из одного пункта, он также нумеруется.

Если текст документа подразделяется только на пункты, они нумеруются порядковыми номерами в пределах документа.

Пункты, при необходимости, могут быть разбиты на подпункты, которые должны иметь порядковую нумерацию в пределах каждого пункта, например: 4.2.1.1 , 4.2.1.2 , 4.2.1.3 и т.д.

Внутри пунктов или подпунктов могут быть приведены перечисления (в приложении MS Word они называются маркированными списками). Каждый пункт, подпункт и элемент перечисления пишут с абзацного отступа.

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

Обратите внимание: переносы слов в заголовках не допускаются.

Между заголовком и текстом, между заголовками раздела и подраздела должны быть увеличенные междустрочные интервалы.

В начале документа большого объема помещают содержание, включающее номера и наименования разделов и подразделов с указанием номеров страниц.

В п. 4.2 ГОСТ 2.105-95 приведены правила изложения текста документов . Эти правила адресованы в основном разработчикам ТЗ на АС, однако некоторые из них полезно знать всем работникам, чья деятельность связана с составлением и оформлением документов.

Например, не только в тексте ТЗ, но и в тексте любого документа рекомендуется соблюдать ограничения, предусмотренные ГОСТ 2.105-95. Так, согласно подп. 4.2.3 ГОСТ 2.105-95 в тексте документа не допускается:

– применять обороты разговорной речи, техницизмы, профессионализмы;

– применять для одного и того же понятия различные научно-технические термины, близкие по смыслу (синонимы), а также иностранные слова и термины при наличии равнозначных слов и терминов в русском языке;

– применять произвольные словообразования;

– применять сокращения слов, кроме установленных правилами русской орфографии, соответствующими государственными стандартами, а также в данном документе;

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

В соответствии с подп. 4.2.4 ГОСТ 2.105-95 в тексте документа, за исключением формул, таблиц и рисунков, не допускается:

– применять математический знак минус (–) перед отрицательными значениями величин (следует писать слово «минус»);

– применять знак «Ø» для обозначения диаметра (следует писать слово «диаметр»);

– применять без числовых значений математические знаки, например > (больше), < (меньше), = (равно), ≥ (больше или равно), ≤(меньше или равно), ≠ (не равно), а также знаки № (номер), % (процент).

Если в тексте приводится ряд числовых значений, выраженных в одной и той же единице физической величины, то ее указывают только после последнего числового значения, например: 1,50 ; 1,75 ; 2,00 м .

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

От 1 до 5 мм.

От плюс 10 до минус 40 °С.

Недопустимо отделять единицу физической величины от числового значения (переносить их на разные строки или страницы).

Наш совет. Чтобы не допустить отделение единицы измерения физической величины от ее числового значения, используйте неразрывный пробел: после числового значения вместо клавиши «пробел» нажмите сочетание клавиш «Ctrl + Shift + пробел ».

В подп. 4.2.21 ГОСТ 2.105-95 разъясняется, что примечания следует помещать непосредственно после текстового, графического материала или в таблице, к которым относятся эти примечания, и печатать с прописной буквы с абзаца. Если примечание одно, то после слова «Примечание» ставится тире и примечание печатается тоже с прописной буквы. Одно примечание не нумеруют. Несколько примечаний нумеруют по порядку арабскими цифрами. Примечание к таблице помещают в конце таблицы над линией, обозначающей окончание таблицы.

Примеры оформления примечаний:

Примечание – ________________________________________________________

Примечания

1. __________________________________________________________________

2. __________________________________________________________________

Обратите внимание! Согласно подп. 4.6.2 ГОСТ 2.105-95 примеры, которые приводятся в тексте документа, размещают, нумеруют и оформляют так же, как и примечания (подп. 4.2.21 ГОСТ 2.105-95).

Правила оформления иллюстраций и приложений приведены в п. 4.3 ГОСТ 2.105-95.

Иллюстрации , за исключением иллюстраций приложений, следует нумеровать арабскими цифрами сквозной нумерацией. Если рисунок один, то он обозначается: Рисунок 1 . Иллюстрации каждого приложения обозначают отдельной нумерацией арабскими цифрами с добавлением перед цифрой обозначения приложения, например: Рисунок А.3 . Мелкие иллюстрации, которые размещены непосредственно в тексте и на которые в дальнейшем нет ссылок, допускается не нумеровать.

Допускается нумеровать иллюстрации в пределах раздела. В этом случае номер иллюстрации состоит из номера раздела и порядкового номера иллюстрации, разделенных точкой, например: Рисунок 1.1 .

Иллюстрации, при необходимости, могут иметь наименование и пояснительные данные (подрисуночный текст). Слово «Рисунок» и наименование помещают после пояснительных данных и располагают следующим образом: Рисунок 1 – Детали прибора .

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

Каждое приложение следует начинать с новой страницы с указанием наверху посередине страницы слова «Приложение» и его обозначения, а под ним в скобках для обязательного приложения пишут слово «обязательное», а для информационного – «рекомендуемое» или «справочное». Приложение должно иметь заголовок, который записывают симметрично относительно текста с прописной буквы отдельной строкой.

Приложения обозначают заглавными буквами русского алфавита, начиная с А, за исключением букв Ё, З, Й, О, Ч, Ь, Ы, Ъ. Допускается обозначение приложений буквами латинского алфавита, за исключением букв I и О. Если в документе одно приложение, оно обозначается «Приложение А».

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

Все приложения должны быть перечислены в содержании документа (при наличии) с указанием их номеров и заголовков.

Таблицы. Их построению посвящен п. 4.4 ГОСТ 2.105-95. Это наиболее полное и подробное описание правил создания и оформления таблиц в текстовых документах из тех, с которыми автору приходилось встречаться.

Рассмотрим наиболее важные правила из тех, что приведены в п. 4.4 ГОСТ 2.105-95.

Таблицы (за исключением таблиц приложений) следует нумеровать арабскими цифрами сквозной нумерацией. В каждом приложении таблицы нумеруют отдельно арабскими цифрами с указанием перед цифрой обозначения приложения. Например:

Таблица 1 – если в документе одна таблица;

Таблица В.1 – если таблица приведена в приложении В.

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

Обратите внимание! В тексте документа должны быть приведены ссылки на все таблицы документа , при ссылке следует писать слово «таблица» с указанием ее номера.

Заголовки граф и строк (см. рисунок) таблицы следует писать с прописной буквы, а подзаголовки граф – со строчной, если они составляют одно предложение с заголовком, или с прописной буквы, если они имеют самостоятельное значение. В конце заголовков и подзаголовков точки не ставят. Заголовки и подзаголовки граф указывают в единственном числе.

Обратите внимание! Разделять заголовки и подзаголовки боковика и граф диагональными линиями не допускается.

Таблицу, в зависимости от ее размера, помещают под текстом, в котором впервые дана ссылка на нее, или на следующей странице, а при необходимости – в приложении к документу.

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

Слово «Таблица» указывают один раз слева над первой частью таблицы, над другими частями (также слева) пишут слова «Продолжение таблицы» с указанием номера (обозначения) таблицы.

Обратите внимание! В соответствии с Изменением № 1, введенным в действие приказом Ростехрегулирования от 22.06.2006 № 117-ст, при подготовке текстовых документов с использованием программных средств (например, приложения MS Word или MS Excel) надпись «Продолжение таблицы» допускается не указывать .

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

Обратите внимание! Графу «Номер по порядку» в таблицу включать не допускается . Нумерация граф таблицы арабскими цифрами допускается в тех случаях, когда в тексте документа имеются ссылки на них, при делении таблицы на части, а также при переносе части таблицы на следующую страницу. При необходимости нумерации показателей, параметров или других данных порядковые номера следует указывать в первой графе (боковике) таблицы непосредственно перед их наименованием.

Если все показатели, приведенные в графах таблицы, выражены в одной и той же единице физической величины, то ее обозначение необходимо помещать над таблицей справа, а при делении таблицы на части – над каждой ее частью.

Для сокращения текста заголовков и подзаголовков граф отдельные понятия заменяют буквенными обозначениями, установленными ГОСТ 2.321-84 «ЕСКД. Обозначения буквенные» (переиздан в марте 2002 г.), или другими обозначениями, если они пояснены в тексте или приведены на иллюстрациях, например D – диаметр , Н – высота , L – длина .

Текст, повторяющийся в строках одной и той же графы и состоящий из одиночных слов, чередующихся с цифрами, заменяют кавычками (»). Если повторяющийся текст состоит из двух и более слов, при первом повторении его заменяют словами «То же», а далее кавычками. Если предыдущая фраза является частью последующей, то допускается заменить ее словами «То же» и добавить дополнительные сведения.

Обратите внимание! Заменять кавычками повторяющиеся в таблице цифры, математические знаки, знаки процента и номера, обозначение марок материалов и типоразмеров изделий, обозначения нормативных документов не допускается. При отсутствии отдельных данных в таблице следует ставить прочерк (тире).

Сноски. Их оформление регламентировано п. 4.5 ГОСТ 2.105-95.

Согласно подп. 4.5.1 ГОСТ 2.105-95 сноски в тексте располагают с абзацного отступа в конце страницы, на которой они обозначены, и отделяют от текста короткой тонкой горизонтальной линией с левой стороны, а к данным, расположенным в таблице, – в конце таблицы над линией, обозначающей окончание таблицы.

В соответствии с подп. 4.5.3 данного стандарта нумерация сносок производится отдельно для каждой страницы. В качестве знаков сноски используют арабские цифры со скобкой. Допускается вместо цифр выполнять сноски звездочками (*). Применять более четырех звездочек не рекомендуется.

Правила оформления документов, приведенные в ГОСТ 2.105-95, проиллюстрированы рисунками, которые не приведены в статье, но с которыми имеет смысл ознакомиться – эти иллюстрации помогут вам лучше понять требования государственного стандарта.

Техническое задание важно и исполнителю, и клиенту. Исполнителю оно помогает лучше понять, что хочет заказчик, застраховаться от внезапных «хотелок» со стороны клиента, ускорить работу по выполнению задачи. Клиенту - рассказать точно о том, что он хочет, упростить контроль качества, получить точную стоимость услуги. Мы расскажем о том, как правильно составить ТЗ и что с ним потом делать.

Что такое техническое задание

Техническое задание - документ, в котором отражены все требования к будущему продукту. В нем описывают все технические требования. Обычно ТЗ составляют в виде текстового документа, редко - в других форматах.

ТЗ используют все разработчики сайтов. Верстальщикам, программистам, дизайнерам оно помогает лучше понять требования клиента и сделать ресурс, соответствующий его ожиданиям. Кроме того, ТЗ используют во всех других сферах, например - в:

  • разработке приложений;
  • проектировании дома;
  • написании текстов и другие.

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

Как составить техническое задание: структура ТЗ на сайт

Прежде чем приступать к работе:

  • Определитесь, кто будет составлять техническое задание
  • Разъясните термины
  • Откажитесь от субъективных терминов

На первый взгляд кажется, что ТЗ на сайт должен составлять клиент , потому что он заказывает ресурс и выдвигает требования к нему. На самом деле в процессе должны участвовать оба: клиент озвучивает требования, а исполнитель записывает их конкретно, точно и понятно. Например, клиент говорит, что хочет сайт, адаптированный под всех пользователей, а разработчик прописывает требования к адаптивности под 4 доступных размера - ПК, ноутбуки, планшеты, смартфоны.

Разъяснение терминов - очень важный момент . Все узкоспециализированные термины желательно объяснить в самом начале - клиенты не всегда знают, что такое подвал (футер), CMS, рыба. Чем проще и понятнее будут объяснения, тем понятнее будет ТЗ для обеих сторон.

Субъективные термины могут вызвать ненужные споры . Не пишите «дизайн должен быть красивым» - понятие красоты у всех разное. То же относится к качественным прилагательным «удобный», «легкий в использовании», «большой». Используйте конкретные цифры и параметры: например, опишите цветовую гамму или расположение элементов.

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

Опишите сайт

Расскажите, какой тип сайта нужен, кем он будет использоваться, для чего он вообще создается. Например, напишите, что вам нужен интернет-магазин, лендинг для продажи товара или сайт-визитка с 10 страницами. Укажите ориентировочное количество страниц, если не знаете точного числа.

Если у проекта есть конкретная целевая аудитория, опишите ее. Это поможет создать ресурс, который понравится клиентам - например, использовать подходящие выражения в статьях или дизайн, который нравится молодежи или представителям старшего поколения.

Расскажите о структуре

Без представления о структуре невозможно разработать нормальный сайт. Распишите, какие страницы будут на сайте, и покажите уровни их вложенности. Сделать это можно разными способами:

  • Схемой
  • Таблицей
  • Списком

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


Пример простейшей структуры в виде блок-схемы

Опишите, что будет на каждой из страниц

Расскажите, какими видите страницы сайта. Делать это желательно в формате прототипа, чтобы наглядно продемонстрировать расположение каждого элемента. Можно описать требования и списком, например - рассказать, что будет в шапке сайта, где расположена форма обратной связи, что будет в свободной боковой колонке.

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


Пример прототипа главной страницы сайта: все просто, удобно, понятно

Выдвините требования к дизайну

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

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

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

Опишите требования к инструментам, коду, хостингу, домену

Это нужно, чтобы заранее знать, с какими инструментами можно работать, а с какими - нет. Опишите отдельным блоком:

  • На какой должен находиться сайт - Вордпресс, Джумла, Модэкс и так далее
  • Какой язык программирования можно использовать - PHP, JavaScript, HTML, другие
  • На каком хостинге и в какой доменной зоне должен располагаться сайт, какое доменное имя можно использовать
  • Какую программную платформу можно использовать - .NET, OpenGL, DirectX
  • И так далее

Если клиент не понимает ничего в используемых терминах - объясните, чем отличается Вордпресс от Модэкса, PHP от HTML, домен в зоне.ru от домена в зоне.com. Вместе составьте требования так, чтобы они устроили клиента.

Уточните требования к работе сайта

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

  • Приемлемую для вас скорость загрузки сайтов или стандартное значение - 1–5 секунд
  • Кроссбраузерность - распишите, в каких браузерах сайт должен открываться
  • Адаптивность - укажите размеры экранов, под которые должен подстраиваться дизайн, и используемые устройства
  • Устойчивость к нагрузкам - сколько человек должно находиться на сайте одновременно, чтобы он не «лег»
  • Устойчивость к хакерским и dDos-атакам: сайт должен выдержать небольшие атаки

Распишите сценарии работы сайта

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


Пример простейшего сценария работы сайта

Уточните, кто занимается контентом.

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

  • - не меньше 95% по Адвего, Текст.ру, Контент.Вотч
  • Тошноте (заспамленности)- не более 10% по Адвего иди 65% по Текст.ру
  • Баллам по Главреду - не менее 6,5 или 7 баллов

Конечно, разные сервисы - не панацея, но они минимизируют риск того, что он будет «водянистым» или переспамленным. Кроме того, так появляются точные критерии оценки качества текстов.

Укажите сроки

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

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

Запомните: в каждом ТЗ должны быть несколько основных блоков:

  • Цели и задачи - о том, для чего вообще вы создали ТЗ, что хотите сделать с продуктом
  • Каким должен быть продукт - описание в общих чертах
  • Технические требования - площадь дома, объем текста, функционал приложения и так далее
  • Сроки - они важны, чтобы исключить споры.

Пример составления ТЗ на программное обеспечение

Нужно создать ПО. Технические требования - ниже.

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

Что должно делать ПО: после ввода ключевого слова находит статьи на сайтах, которые внесены заранее в качестве авторитетных источников, выводит список совпадений в таком формате:

  • Линк
  • Название статьи
  • Лид-абзац

Если больше 10 совпадений, нужно разделить на страницы - по 10 на каждой.

Технические требования: язык программирования - любой, не принципиально. Главное, чтобы программу потом можно было доработать и вывести в качестве онлайн-сервиса. В идеале сервис должен искать за 10 секунд.

Сроки : до 15.09.2018.

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

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

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

В определении технического задания на Википедии, в частности, говорится, что это «документ, содержащий требования заказчика к объекту закупки, определяющие условия и порядок ее проведения для обеспечения государственных или муниципальных нужд, в соответствии с которым осуществляются поставка товара, выполнение работ, оказание услуг и их приемка».

Кроме того, есть ряд ГОСТов, например, 19.201-78, в которых прописано, что и в каком виде должно содержаться в подобном документе.

Однако, как показывает практика, под заветной аббревиатурой «ТЗ» понимаются совершенно разные по сути, содержанию, оформлению и детализации документы. К сожалению, многие заказчики уверены, что, написав пару страниц требований к будущей системе, они получат от нас точную (максимум с дельтой в 10-20%) оценку с календарным планом работ. Получая в очередной раз на почту «ТЗ, по которому к завтрашнему дню надо дать оценку и выслать КП», я всегда морально готовлюсь увидеть очередное творение в стиле «система должна обмениваться с сайтом всей необходимой информацией».

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

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

Так как же составить ТЗ, по которому в итоге получится именно то, что было заложено его автором(-ами), а не то, что «умеет типовой функционал конфигурации»?

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

Документы, с которыми мне приходилось сталкиваться, и на основании которых были получены максимально близкие к задумке результаты, обладали следующими свойствами:

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

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

3. Usability. Из двух предыдущих пунктов есть простое следствие – понятная логика работы и максимальная визуализация будущей системы помогут в итоге заложить в ТЗ нужное количество примечаний\пунктов, касающихся удобства использования системы. Для систем, с которыми работают низкоквалифицированные сотрудники, это может стать решающим фактором успешности проекта (впрочем, этот параметр также крайне важен и для топ-менеджмента, не желающего иметь дела с «этими бухгалтерскими программами»). Например, в ТЗ на систему для розничных продаж не указали, что поиск артикула должен занимать не более трех секунд. Если бы систему реализовали через типовой поиск конфигурации, то это могло привести к критическим ситуациям в реальной эксплуатации, т.к. с учетом количества номенклатуры этот поиск занимал до 30 секунд, что недопустимо при работе с розничными покупателями, где каждая секунда на счету.

4. Ссылки на популярные решения . Зачастую, для всех, к примеру, менеджеров по продажам компании, фраза «функционал ведения сделок» означает примерно одно и то же, но для сотрудников подрядчика эта фраза не значит ровным счетом ничего. Но добавьте пару слов в эту фразу, и из варианта «карточка сделки, аналогичная таковой в Битрикс24(или 1С:CRM)» уже понятно, чего примерно ожидает от этой самой карточки Заказчик.

5. Первичная обратная связь . Еще раз повторюсь - для успешной реализации ТЗ его не обязательно писать по ГОСТу. Не нужно писать документ, предназначенный только техническим специалистам. Техническое задание в первую очередь должно быть понятно коллегам его составителя, а потом и тем, кто будет его реализовывать. Крайне важно получить положительную обратную связь от коллег бизнес-пользователей, прежде чем направлять документ потенциальным подрядчикам или внутреннему отделу разработки. Документ, предельно ясный одному человеку, но не понятный даже ближайшему окружению не имеет шансов на успешную реализацию.

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


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

Как правило, этапу составления технического задания предшествует проведение обследования предметной области, которое завершается созданием аналитического отчета. Именно аналитический отчет (или аналитическая записка) ложится в основу документа Техническое задание.

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

Таким образом, техническое задание является документом, который позволяет как разработчику, так и заказчику представить конечный продукт и впоследствии выполнить проверку на соответствие предъявленным требованиям.

Руководствующими стандартами при написании технического задания являются ГОСТ 34.602.89 «Техническое задание на создание автоматизированной системы» и ГОСТ 19.201-78 «Техническое задание. Требования к содержанию и оформлению» . Первый стандарт предназначен для разработчиков автоматизированных систем, второй для программных средств (разницу между данными сериями мы обсуждали в статье «Что такое ГОСТ»).

Итак, ниже мы представляем список и описание разделов, которые должно содержать техническое задание согласно ГОСТам.

ГОСТ 19.201-78 Техническое задание. Требования к содержанию и оформлению

ГОСТ 34.602.89 Техническое задание на создание автоматизированной системы

1. Введение

1. Общие сведения

2. Основания для разработки

3. Назначение разработки

2. Назначение и цели создания системы

3. Характеристика объекта автоматизации

4. Требования к программе или программному изделию

4. Требования к системе

4.1. Требования к функциональным характеристикам

4.2. Требования к функциям (задачам), выполняемым системой

4.1. Требования к системе в целом

4.1.1. Требования к структуре и функционированию системы

4.1.3. Показатели назначения

4.2. Требования к надежности

4.1.4. Требования к надежности

4. 1.5. Требования к безопасности

4. 1.6. Требования к эргономике и технической эстетике

4.3. Условия эксплуатации

4.1.2. Требования к численности и квалификации персонала системы и режиму его работы

4. 1.9. Требования к защите информации от несанкционированного доступа

4. 1.10. Требования по сохранности информации при авариях

4. 1.11. Требования к защите от влияния внешних воздействий

4. 1.12. Требования к патентной чистоте

4. 1.13. Требования по стандартизации и унификации

4.4. Требования к составу и параметрам технических средств

4. 1.8. Требования к эксплуатации, техническому обслуживанию, ремонту и хранению компонентов системы

4.5. Требования к информационной и программной совместимости

4.6. Требования к маркировке и упаковке

4.7. Требования к транспортированию и хранению

4. 1.7. Требования к транспортабельности для подвижных систем

4.8. Специальные требования

4. 1.14. Дополнительные требования

4.3. Требования к видам обеспечения

5. Требования к программной документации

8. Требования к документированию

6. Технико-экономические показатели

7. Стадии и этапы разработки

5. Состав и содержание работ по созданию системы

8. Порядок контроля и приемки

6. Порядок контроля и приемки системы

7. Требования к составу и содержанию работ по подготовке объекта автоматизации к вводу системы в действие

9.Источники разработки

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

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

  • Общие сведения о системе (программе);
  • Назначение, цели и задачи системы (программы);
  • Требования к системе (функциональные требования, пользовательские требования, требования к системе в целом и тд);
  • Требования к видам обеспечения;
  • Требования к документированию;
  • Стадии и этапы разработки;
  • Порядок контроля и приемки системы (программы).

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

Пример:

«В данном документе создаваемая информационная система называется «Единое окно доступа к образовательным ресурсам», сокращенно ЕО.
Систему Единое окно доступа к образовательным ресурсам далее в настоящем документе допускается именовать Единое окно или Система.»

Также сюда следует включить подразделы сообщающие реквизиты организаций участвующих в разработке (Заказчика и Исполнителя).

В подразделе «Основания для разработки» документа Техническое задание перечисляются основные документы, на основании которых выполняются данные работы. Например, для системы, выполняемой по заказу Правительства страны или другого Государственного органа, должны быть указаны законы, указы и постановления Правительства.

Неотъемлемой частью документа Техническое задание также должен быть список терминов и сокращений. Термины и сокращения лучше представить в виде таблицы с двумя столбцами «Термин» и «Полная форма».

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

Назначение и цели создания системы

Данный раздел документа Техническое задание должен содержать назначение и цели создания системы.

Пример:

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

Основной целью Системы является формирование единой информационной среды и автоматизации бизнес-процессов Образовательных учреждений Российской Федерации.

Создание информационной системы «Единое окно» должно обеспечить:

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

Создание Системы позволит сократить эксплуатационные затраты в результате повышения эффективности работы ведомства.»

Требования к системе

Данный раздел документа Техническое задание предназначен для описания основных функциональных требований системы. Это самая важная часть технического задания, так как именно она станет основным вашим аргументом при спорах с Заказчиком в процессе сдачи системы в эксплуатацию. Поэтому к его написанию необходимо подойти наиболее тщательно.

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

Пример:

«4.1 Бизнес-процесс «Предоставление информации об образовательных учреждениях Российской Федерации

В данном бизнес-процессе выделяются следующие участники:

Модератор – работник ведомства, входящий в состав обслуживающего персонала Системы, ответственный за корректность предоставляемых данных

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

4.1.1 Регистрация образовательного учреждения в Системе

Регистрация образовательного учреждения Российской Федерации осуществляется ответственным сотрудником учреждения («Постановление Правительства …»).

Процесс регистрации образовательного учреждения включает следующие шаги:

  • Автор создает запись об организации;
  • Автор заносит данные организации;
  • Система проверяет наличие лицензии для данной организации
    • Если лицензия существует в базе данных, Система отправляет Автору сообщение об успешной регистрации;
    • Если лицензия не найдена в базе данных, Система отправляет сообщение Автору об отсутствии лицензии для данной организации.»

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

Требования к системе в целом включают раскрытие ее архитектуры с описанием всех подсистем. В данной части Технического задания следует описать требования к интеграции системы с другими продуктами (если таковые имеются). Далее в техническое задание должны быть включены:

  • требования к режимам функционирования системы
  • показатели назначения
  • требования к надежности
  • требования к безопасности
  • требования к численности и квалификации персонала и режиму его работы
  • требования к защите информации
  • требования по сохранности информации при авариях
  • требования к патентной чистоте
  • требования по стандартизации и унификации
  • и т.д.

Требованиям к видам обеспечения

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

Требования к документированию

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

Данный раздел технического задания также важен, как и описание функциональных требований, поэтому не следует ограничиваться фразой «Заказчику должна быть предоставлена вся документация согласно ГОСТ 34». Это означает, что вы должны предоставить весь пакет документов включая «Формуляр», «Паспорт» и т.п. Большинство документов из списка, указанного в ГОСТ 34.201-89 не нужны ни вам, ни заказчику, поэтому лучше сразу согласовать список на этапе разработки документа Техническое задание.

Минимальный пакет документов обычно включает:

  • Техническое задание;
  • Ведомость эскизного (технического) проекта;
  • Пояснительная записка к Техническому проекту;
  • Описание организации информационной базы;
  • Руководство пользователя;
  • Руководство администратора;
  • Программа и методика испытаний;
  • Протокол приемочных испытаний;
  • Акт выполненных работ

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

Стадии и этапы разработки

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

Описание этапа должно включать наименование, сроки, описание работ и конечный результат.

Порядок контроля и приемки системы

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

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

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



© 2024 solidar.ru -- Юридический портал. Только полезная и актуальная информация