Подготовить техническое задание на разработку. Как правильно составить техзадание

  • Agile ,
  • Управление продуктом
    • Recovery Mode

    Данный текст был создан сугубо ради существования постоянной ссылки, которую бы сам автор, да и все вы - могли бы смело отправлять своим будущим заказчикам, коллегам, родственникам и знакомым в виде стандартизированного ответа на вопрос: «А надо ли мне ваше ТЗ и вообще что это?»

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

    Проблема

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

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

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

    2) Собственно из первого пункта логично вытекает и новый - сам текст ТЗ обязан начинаться с главы «Цели и задачи», четко формулирующей, какие бизнес-цели преследует вся эта очередная попытка повысить энтропию в мире. Бесцельное задание, которое не решает никаких проблем, не достигает ничего и делается «от скуки» - официально не считается Техническим Заданием, а с этого момента находится в статусе «обычная бумажка».

    3) Как же вам понять, решает ли предложенная дизайн-концепция или интерактивный прототип, а то и готовый к употреблению сайт - вышеизложенную задачу бизнеса? Ничего не поделаешь, придется опять вернуться к определению: «определяет… ожидаемые результаты и сроки выполнения. То есть должны быть объективные критерии, по которым можно определить, сделан ли тот или иной пункт работ или нет». То есть ТЗ без четких измеримых показателей в рублях, секундах, тонно-километрах или градусах Цельсия - быть не может. Бриф может, или прототип, или еще любая абсурдная бумажка, но только не ТехЗадание.

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

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

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

    5) Каждое внесение правок в готовое ТЗ должно стоить денег. Нельзя бесплатно и бесконечно править «Конституцию вашего проекта» только потому, что одна из сторон передумала, не выспалась, внезапно решила сэкономить и т.д. Цена каждого изменения в ТЗ должна также четко прописываться заранее в соответствующей главе.

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

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

    Итак: Что делаем? Для чего? Как поймем, что сделали? Сколько стоит каждый пивот? - написанные на листочке ответы на все эти вопросы и являются «серебряной пулей», способной вытащить даже самый провальный проект.

    Контрольные вопросы
    А здесь перечислю ответы на самые часто встречающие вопросы от заказчиков:

    1) Так что, на написание ТехЗадания может еще и официальный ГОСТ есть? - Да, даже несколько.

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

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

    4) Вот вы и Википедия пишете, что ТЗ создается заказчиком. Но я не умею\мне некогда\просто не хочу его делать сам. Как же быть? - Отдать разработку ТЗ третьей стороне, вполне знакомой с вашим бизнесом, его задачами, целевой аудиторией и потребностями, и в то же время досконально осведомленной о всех этапах веб-разработки. Эта третья сторона станет неким «веб-нотариусом», то есть гарантом того, что исполнитель не занизит нужные вам показатели или не затянет сроки, и что заказчик установит достижимые метрики и на итоговой приемке не будет субъективно оценивать созданный продукт, на ходу изменяя зафиксированные ранее требования.

    5) И что, если ТЗ является юридическим документом, то я потом могу засудить аутсорсера, не заплатить ему, заставить переделать все в десятый раз? - Если документ составлен правильно, указаны цели и методология оценки их достижения; если документ подписан сторонами и упомянут в Договоре (само ТехЗадание договором не является) - то конечно же сможете. А вот с обычным брифом, прототипами, арт-креатив-макетом, Безопасной сделкой на FL - уже нет.

    6) Мне говорят, что работа будет вестись по какому то то ли скраму, то ли аджайлу; а значит архаичное ТЗ мне больше уже не нужно. Это так? - Посудите сами: вам называют непонятное слово, явно что-то маскирующее и вот уже на основании незнакомого вам термина предлагают отказаться от юридически грамотного и наполненного целями и метриками документа. Сам же agile никаких целей вроде «достичь не менее 10 000 посещений к концу года», или «достичь цифры более 25 заказов с сайта через месяц» - установить не может, это просто способ проведения совещаний и новой организации нерадивых сотрудников. Задумайтесь несколько раз: «А не пускают ли вам пыль в глаза?». На самом деле никакому новомодному скраму профессиональное ТЗ повредить не может, а вот помочь - обязательно.

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

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

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

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

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

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

    Научно-исследовательских работ,

    Опытно-конструкторских работ,

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

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

    Техническое задание должно содержать три основных раздела:

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

    2. перечень документов, требующих совместного рассмотрения Заказчиком и Разработчиком,

    3. порядок сдачи и приемки результатов разработки.

    При необходимости техническое задание может содержать также требования к подготовке и освоению производства.

    Конкретное содержание технического задания определяют Заказчик и Разработчик, а при инициативной разработке - Разработчик.

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

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

    Техническое задание должно содержать максимум информации, облегчающей работу конструктора и сокращающей сроки разработки.

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

    Научно-техническая информация,

    Патентная информация,

    Характеристика рынка сбыта,

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

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

    Прогнозируемые показатели технического уровня и качества,

    Основное назначение,

    Характеристика рынка сбыта,

    Технические и тактико-технические характеристики,

    Уровень стандартизации и унификации,

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

    Патентно-правовые показатели,

    Специальные требования к изделию и др.

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

    Общий порядок разработки и утверждения технического задания устанавливает Государственный стандарт России ГОСТ 15.001-88

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

    Техническое задание оформляют в соответствии с общими требованиями к текстовым конструкторским документам согласно Государственного стандарта ГОСТ 2.105-95.

    Таблица 1

    Основные разделы технического задания

    Примерный перечень вопросов,

    рассматриваемых в разделе

    Наименование и область применения (использования).

    Наименование и условное обозначение разрабатываемой продукции.

    Краткая характеристика области ее применения.

    Общая характеристика объекта, в котором используют продукцию.

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

    Полное наименование документа, на основании которого разрабатывают продукцию.

    Организация, утвердившая этот документ, и дата его утверждения.

    Наименование и условное обозначение темы разработки.

    Цель и назначение разработки

    Эксплуатационное и функциональное назначение, перспективность производства продукции.

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

    Перечень научно-исследовательских и других работ.

    Перечень экспериментальных образцов и макетов.

    Технические (тактико-технические) требования

    Состав продукции и требования к конструктивному решению.

    Требования к техническим показателям.

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

    Требования к технологичности.

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

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

    Эстетические и эргономические требования.

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

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

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

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

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

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

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

    Экономические показатели

    Ориентировочная экономическая эффективность и срок окупаемости затрат.

    Предельная себестоимость.

    Предполагаемая годовая потребность в продукции.

    Экономические преимущества разрабатываемой продукции по сравнению с аналогами.

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

    Стадии разработки, этапы работ и сроки их выполнения (сроки, указываемые в техническом задании, являются ориентировочными: основные сроки указываются в плане работ или в договоре на разработку нового изделия).

    Предприятие-изготовитель разрабатываемого изделия.

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

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

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

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

    Общие требования к приемке работ на стадиях разработки.

    Количество изготавливаемых опытных образцов продукции.

    Приложения к техническому заданию

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

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

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

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

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

    Как писать техническое задание?!

    Создан 05.02.2005 11:41:19

    Твой мир пуст...

    Кто печаль твою разделит?

    «Как писать техническое задание?!» - из уст т. н. начинающего «технического писателя», далее по тексту - техписа. Вот она - страшная цена развала Союза и переход российской высшей школы на двухступенчатую систему образования.

    Вернемся к вопросу. При «раскладке» получается:

    • первый вопрос - «а зачем оно надо»;
    • второй вопрос - какова должна быть структура разделов «Техническое задание»;
    • третий вопрос - какие существуют способы подготовки текстов содержимого разделов технического задания?

    Третий - самый сложный. Ответы на указанные вопросы появятся в ходе изложения.

    Цели и задачи статьи

    Цель статьи - облегчить жизнь совсем уж начинающим техписам.

    Задачи статьи:

    • дать ответы на поставленные вопросы;
    • показать необходимый минимум практических подготовки текстов технического задания;
    • дать начинающему техпису шанс:
      • повысить собственный рейтинг;
      • или окончательно уронить себя в глазах Большого Босса.

    История

    Все, что когда-либо производилось, производится и будет производиться, делится (условно, разумеется) на:

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

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

    Первой автоматизированной системой, возможно, стала ветряная мельница. Вытащил стопор - «лопасти» вращаются, жернова молотят. «Нажатие одной кнопки» - 100-процентная автоматизация.

    История, леденящая душу

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

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

    Настало время, прибыл царь на мельницу (работ). Смотрит и диву дается - крылья крутятся, жернова жито молотят, мука сама собой в мешки сыплется! (Полное соответствие требованиям к функциям (задачам), выполняемым системой). Да возьми и запусти руку в мешок... (что не было предусмотрено ни, ни, поскольку не существовало таковых).

    Побагровел царь - что ж, смерд, мельница сия муку непотребно мелет?! (Несоответствие производимой требованиям ГОСТ 7045-90 Мука ржаная хлебопекарная.). Схватили мужика опричники, да долбанули по буйной его головушке топором каменным. И кончил жизнь Левша под звуки «Реквиема» Моцарта из музыкального автомата...

    Выводы

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

    Издавались Указы, Распоряжения - «в университете московском студиозусам надобно на соломе сидеть, сморкаться в кулак, нос утирать пучком соломы. А нарушивших правила сии розгами драть нещадно» (или что-то в этом роде).

    Равноправия нет и сейчас - кто платит, тот и заказывает музыку. А платит заказчик.

    Примечание от 10.05.2014 г. - Но не все так печально Если действовать с умом, то можно запросто прогнуть любого заказчика, см. и.

    Современное состояние

    И было придумано то, что сделали танк...

    из серии «Армейские приколы»

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

    Может быть, все было иначе, но танк, в целом, получился хорош - что подтверждается и представителями ГОССТАНДАРТа, и отзывами опытных разработчиков.

    Техническое задание и его назначение

    Большому Боссу, непосредственно взаимодействующему с заказчиком, техническое задание дает возможность избежать участи мастера-умельца (об этом ранее упоминалось неоднократно).

    Для маааааааленького техписа, работающего на Большого Босса, разработка технического задания есть:

    • средство заработать себе «таки на покушать»;
    • способ показать, что техпис - не тварь дрожащая, а право имеет - способ вырасти в глазах Большого Босса.

    Крайнее утверждение - палка о трех концах. Ах, ты умный, умеешь? Так на тебе еще работенки. А жалование поднимем. Когда-нибудь.

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

    Считаем, что первый вопрос (в первом же приближении) закрыт.

    ГОСТы на технические задания

    Куст есть совокупность веток, произрастающих из одной точки.

    Военная мудрость

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

    Примечания:

    1. Существуют и иные отечественные ГОСТы, содержащие требования к содержанию и оформлению документа «Техническое задание». Сей факт обусловен спецификой. Перечисленная четверка была и остается для большинства предметных областей;
    2. Техзадание было и остается основополагающим документом, той самой «точкой опоры», из которой все и произрастает.

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

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

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

    Потребовалось разработать техническое задание на изделие - пользуемся ГОСТ 2.114-95, поскольку ГОСТ 15.001 - кривой по жизни, а разделы технических условий (в целом) соответствуют разделам технического задания. Надо - открываем ГОСТ 34.602-89. На - ГОСТ 19.201-78.

    Покажем необходимый минимум практических приемов, позволяющих даже самому начинающему техпису немедленно приступить к разработке содержимого разделов техзадания и достичь приемлемых результатов (отдельные готовые структурные элементы технического задания по ГОСТ 34.602-89 можно найти в «подвале» данной статьи).

    Практические приемы

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

    Самый первый прием - создание документа с ГОСТированной структурой разделов. Если Боссом поставлена задача разработки технического задания, положим, на автоматизированную систему, скачивается ГОСТ 34.602-89 в виде -файла, затем просто открывается вордом и в формате dot.

    Электронные версии ГОСТов, хранящиеся на, в целом соответствуют официальным версиям. Сомнительные моменты всегда можно проверить путем сравнения, если не лень, конечно.

    Примечание от 25.12.2011 г. - На Ростехрегулирования (protect.gost.ru) не так давно стали публиковать официальные версии ГОСТов, правда, далеко не в редактируемом формате...

    Детализация

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

    Вспомним родительское - «пока ты не разложишь все по-полочкам, «ничего у тебя не получится (мама)» или «ни хрена у тебя не выйдет (папа)». И мама, и папа, безусловно, были и остаются бесконечно правы. Несложную задачку по физике решить невозможно, пока векторы сил не будут разбросаны по осям. Тройной интеграл взять невозможно, пока не будут поочередно взяты интегралы по dx, dy и dz. За исключением случая, когда «интеграл настолько прост, что взять его можно даже без dx».

    Произвольно выбранная цитата из ГОСТ 34.602-89:

    Для системы приводят требования к применению в системе, языков взаимодействия и технических средств системы, а также требования к и декодированию, к языкам -, средствам описания (объекта автоматизации), к способам организации [из п. 2.6.3.3 ГОСТ 34.602-89]

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

    4.3.2.1 Требования к лингвистическому обеспечению системы

    4.3.2.1.1 Требования к применению в системе языков программирования высокого уровня

    (текст требования)

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

    (текст требования)

    4.3.2.1.3 Требования к кодированию данных

    (текст требования)

    4.3.2.1.4 Требования к декодированию данных

    (текст требования)

    4.3.2.1.5 Требования к языкам ввода-вывода данных

    (текст требования)

    4.3.2.1.6 Требования к языкам манипулирования данными

    (текст требования)

    4.3.2.1.7 Требования к средствам описания предметной области (объекта автоматизации)

    (текст требования)

    4.3.2.1.8 Требования к способам организации диалога

    (текст требования)

    Увеличился объем технического задания? А стоит ли экономить бумагу? Имеется и еще одна военная мудрость, как бы грубо и двусмысленно она ни звучала: «больше бумаги - чище з@@@@ца». Требования к лингвистическому обеспечению стали выглядеть понятнее?

    Примечание - Термины «понятность», «» (understandability) фигурируют сразу в нескольких ГОСТах. Вот квинтэссенция - «совокупность чего-то, характеризующая затраты усилий человека на понимание логической концепции этого чего-то».

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

    Детализация, детализация и еще раз детализация. До приемлемого (атомарного) уровня.

    Шаблонное построение фраз

    Следует взять на вооружение тот факт, что в каждом вопросе (правильно поставленном) - половина ответа. Допустим, необходимо сформулировать текст подпункта «Требования к применению в системе ». Итак:

    4.3.2.1 Требования к применению в системе языков программирования высокого уровня

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

    • язык C++;
    • язык Pascal;
    • и т.д.

    Для тех, кто не прочувствовал, как построить фразу, слева приведена схема ее построения.

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

    (детализируем - создаем подпункты 4.1.2.1, 4.1.2.2 и 4.1.2.3)

    (правильно формулируем текст подпункта - отвечаем на вопрос, каким требованиям должна удовлетворять численность персонала)

    Численность персонала должна удовлетворять требованиям :

    • быть достаточной для реализации автоматизированных () системы во всех режимах работы системы;

    4.1.2.2 Требования к квалификации персонала

    Квалификация персонала должна обеспечивать эффективное функционирование технических и системы во всех режимах работы системы»

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

    4.1.2.3 Требования к режиму работы персонала

    Режим работы персонала - трехсменный круглосуточный.

    В подразделе предусмотрен также порядок подготовки персонала, контроля знаний и навыков. О составе - ни слова. И это правильно. Состав персонала, деление его на оперативный (), ремонтный и пр., определяется при проектировании системы. Хотя никто не может запретить добавить в техническое задание Требования к составу персонала. Пожалуй, не стоит.

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

    Формализация при подготовке текста технического задания

    Возможно Двести Вариантов

    Один из двухсот вариантов расшифровки аббревиатуры «ВДВ»

    Вернемся к примеру из предыдущего подраздела статьи.

    4.1.2.1 Требования к численности персонала

    Численность персонала должна удовлетворять требованиям:

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

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

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

    Примечание от 17.04.2018 г. - В ОКПДТР должность технического пейсателя тоже отсутствует. А должность укладчика текста так и осталась с прежних времен

    Штампы и унификация при подготовке текста технического задания

    Вы, бабы, красивы,

    А я - без прикрас

    Но, все же, мужчины

    Уходят от вас...

    Ю. Рыбчинский, «Две сестры»

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

    Положим, разрабатывается универсальный преобразователь энергии в энергию человеческого разума (Существование человеческого разума сомнительно. Разумно ли вешать на свою шею работу по созданию такого преобразователя? А вот рефлексы существуют объективно). Следует сразу, в разделе «Наименование изделия» обозвать этот самый преобразователь Изделием:

    Наименование изделия - преобразователь энергии солнечного излучения в энергию человеческого разума (далее по тексту - Изделие ).

    И, в тексте - Изделие, Изделие, Изделие...

    Тоже самое относится к программным изделиям и автоматизированным системам. Наименование АС - автоматизированная система раздачи грубых кормов для крупного рогатого скота (далее по тексту - Система ).

    И, в тексте - Система, Система, Система... Программа, Программа, Программа...

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

    Примечание от 05 февраля 2010 г. - При автоматизированной разработке техдокументации с применением single source приемлем как вариант со всякими склонениями-спряжениями, так и без них. К примеру, можно единожды создать переменную <ЗАО «Заказчик»> и вставлять в требуемые топики библиотеки документов - так иногда бывает удобнее.

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

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

    Любая цель всегда подразумевает положительную динамику , изменение каких-либо показателей в лучшую сторону. К примеру, цель - повышение благосостояния всего советского народа (но не коммунизм: коммунизм - это мишень!). Цель - повышение удовлетворенности заказчика. Исключение составляют:

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

    Встречаются еще и не такие фокусы. Пример из практики одного из самых маститых техписов (пример привел он сам, без всякого принуждения, в одном из техписовских форумов) - « позволяет ... программа выполняет ... программа делает ...». Милостивый государь, технический писатель! Программы еще нет, она еще не разработана, не, не, не, не и не сдана заказчику, поэтому еще ничего не позволяет, не делает и не выполняет. Что за непобедимая совковая привычка выдавать желаемое за действительное?!

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

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

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

    По части рамок задач. Задачи решаются , а функции выполняются . Чтобы решить задачу, надо выполнить ряд функций, процедур или операций. Иными словами - задача есть более крупный структурный элемент вопреки измышлениям.

    В ГОСТ 34.003-90 поставлена впереди, задача является как бы частью функции. И это странно: еще в школе все решали задачки, вычисляя внутри них значения различных функций... И представьте себе, как дико звучала бы декларация: «Цель партии и правительства - повышение благосостояния всего советского народа. Ради достижения цели партия ставит перед собой функцию обеспечения к 2ххх году каждой семьи отдельной квартирой»... (Кстати, заниматься уборкой домов и квартир самостоятельно сейчас уже не модно и некогда особенно - для этого есть клининговые компании). Таким образом, функция является частью задачи, а не наоборот. Пусть даже вопреки священному ГОСТ 34.003-90.

    Итак, пример.

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

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

    И из предыдущего подраздела:

    • должны быть ...;
    • должна удовлетворять требованиям ..

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

    Перечни и нумерация разделов

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

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

    Случай первый.

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

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

    Случай второй.

    «4.3.2.1 В рамках задачи (или для решения задачи ) ведения базы данных программные средства системыдолжны обеспечивать возможность выполнения перечисленных нижефункций :

    1. автоматизированной функции добавления записей в таблицы базы данных;
    2. автоматизированной функции удаления записей из таблиц базы данных;
    3. автоматизированной функции сортировки записей в таблицах базы данных...;»

    Отличия, казалось бы, невелики. Но!

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

    Во втором случае, всего-навсего - «методика проверки выполнения п. 4.3.2.1(1) технического задания».

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

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

    По списки следует «нумеровать» не цифрами, а буквами:

    а) функция такая-то;

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

    Чуть-чуть о. Если в ТЗ имеется подраздел «Метрологическое обеспечение...», то метрологическая экспертиза должна быть проведена по полной программе. Если указанный подраздел отсутствует, то метрологическая экспертиза сводится к проверке сокращений согласно ГОСТ 8.417. И только.

    Связка «общие сведения, назначение и состав» в техническом задании

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

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

    Любой человек начнет рефлекторно просматривать разделы ГОСТа на техническое задание, пытаясь найти хоть какую-то зацепку. Человек с опытом сразу вспомнит о.

    2.1 Назначение системы

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

    Система должна обеспечивать решение (возможность решения) перечисленных ниже задач:

    1. задачи сбора данных с каких-то, допустим, датчиков;
    2. задачи обработки, хранения, отображения и пр. в центре сбора.

    Вот и все. Немного фантазии, и раздел готов:

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

    1. 1-й уровень - уровень сбора данных ;
    2. 2-й уровень - уровень консолидации данных (централизованная обработка, хранение и пр.).

    Снова оба зайца - и наповал. И уровни иерархии перечислены, и степень централизации. А что дальше?

    2.1.1 Уровень сбора данных

    2.1.1.1 Общие сведения

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

    2.1.2.2 Назначение

    Уровень сбора данных предназначен (еще один штамп):

    1. для передачи данных каких-то датчиков уровню консолидации по запросу (инициативе) крайнего (последнего);
    2. для протоколирования передачи данных в журнале событий (а если по ГОСТу, то в);
    3. еще для чего-то.

    2.1.2.3 Состав

    В состав уровня сбора данных должны входить:

    1. датчики такие-то;
    2. датчики еще какие-то.

    В чем удобство использования связки «общие сведения, назначение и состав»? А невольно получается хорошо структурированное техническое задание - древовидное и иерархическое.

    2.2.2.3.1 Датчики такие-то

    2.2.2.3.1.1 Общие сведения (о таких-то датчиках)

    2.2.2.3.1.2 Назначение (таких-то датчиков)

    2.2.2.3.1.3 Состав (таких-то датчиков)

    Главное - вовремя остановиться.

    Предостережение

    При разработке и наибольший интерес представляют перечисленные ниже:

    • прежде всего - . Для таким является;
    • , например и;
    • , например;
    • и, например;
    • ряд других.

    Не следует особенно увлекаться подобными «тематическими» ГОСТами, содержащими очень уж конкретные требования к. Характерная ошибка начинающих - «каналы связи должны удовлетворять требованиям ГОСТ такому-то». Это фатальная ошибка. Известно, что приемке-сдаче работ по созданию системы, изделия, программного изделия всегда предшествует проведение.

    Допустим, Большой Босс, пораженный глубокими познаниями техписа, доверился оному, читать ничего не стал и черканул на титульном листе технического задания утверждающую (под УТВЕРЖДАЮ, в правом верхнем углу титульного листа). Заказчик, с гнусной ухмылкой, аккуратно поставил свою (под УТВЕРЖДАЮ, в левом верхнем углу). Все, техническое задание и внести в него или возможно только по дополнительному соглашению с заказчиком. Вот тут-то техпис и попал.

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

    Что делать? Полбеды, если каналами связи занимался, готовый предоставить Большому Боссу. Босс отмажется перед заказчиком и техпис будет жить (до очередного прокола). Но неприятный осадок в душе Большого Босса останется навсегда. Повышения ждать не приходится.

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

    Короче, писать надо примерно так, русским по белому:

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

    1. каналы связи -;
    2. каналы операторов сотовой связи;
    3. каналы операторов спутниковой связи;
    4. коммутируемые телефонные линии общего пользования;
    5. объекта заказчика;
    6. и так далее»

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

    Заключение

    Итак, вспомним еще разок ключевые моменты:

    1. подготовка технического задания импортом электронной версии требуемого ГОСТа;
    2. детализация - дробление больших по объему разделов технического задания на короткие простые подразделы;
    3. шаблонное построение предложений в разделах (подразделах и пр.) технического задания так, чтобы «в ответе оказывалась половина вопроса»;
    4. формализация содержимого тех разделов, где невозможно (или) давать конкретику;
    5. применение штампов;
    6. применение перечней (маркированных или нумерованных списков);
    7. применение связки «общие сведения, назначение и состав»;
    8. минимальное применение «тематических» ГОСТов.

    В заключении можно дать ряд дополнительных советов:

    • отыскать «рыбу» технического задания и, после критического ее осмысления, позаимствовать содержимое подходящих разделов (только не с известного всем ресурса закупки.гов.ру - там лежит чушь полнейшая);
    • пользоваться документами;
    • без стеснения задавать вопросы.

    Заказать ООО «Техническая документация» можно по эл. почте admin @ tdocs . su (без пробелов), тел. 8-910-468-09-28 или в форме.

    Copyright © ООО «Техническая документация» 2018. Заимствуйте наши материалы с блеском! При воспроизведении материалов портала обязательна установка активной гиперссылки на источник - страницу с этой публикацией на сайт.

    Помните закон Мерфи? Если вас могут понять неправильно, вас обязательно поймут неправильно. Это справедливо не только в общении между людьми, но и в создании сайтов. Клиент хотел второй «Фейсбук», а получил форум юных собаководов. Разработчик не угадал хотелку заказчика - потратил время впустую.

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

    Статья будет полезна:

    • Всем, кто имеет отношение к созданию сайтов: разработчикам, дизайнерам, верстальщикам.
    • Менеджерам проектов.
    • Руководителям диджитал-студий.
    • Предпринимателям, которые планируют заказать разработку сайта.

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

    Что такое техзадание и зачем оно нужно

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

    Главная цель технического задания: убедиться, что клиент и исполнитель правильно поняли друг друга.

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

    Польза для клиента:

    • Понять, за что он платит деньги, и каким будет сайт. Можно сразу увидеть структуру, понять, что и как будет работать. Прикинуть, все ли устраивает. Если нет - без проблем поменять еще до начала разработки.
    • Увидеть компетентность исполнителя. Если техзадание понятное и четкое - доверие к разработчику повышается. Если там написана каша - возможно, стоит бежать и не оглядываться.
    • Застраховаться от недобросовестности исполнителя. Когда сайт готов, его можно проверить по техническому заданию. Есть несоответствия? Разработчик обязан их исправить. Если вы сотрудничаете официально и заключали договор - можно даже принудить через суд.
    • Упростить замену исполнителей. Если клиент и разработчик повздорили и разбежались, создание сайта может сильно затянуться. Когда есть подробное техзадание, его можно передать новой команде - она втянется в работу в разы быстрее.
    • Узнать стоимость разработки сложного продукта. Оценить точные сроки и стоимость разработки сложного веб-сервиса сходу нельзя. Сначала нужно понять, как будет работать сервис, и какие в нем будут функции. Для этого и нужно подготовить техзадание.

    Польза для исполнителя:

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

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

    Техзадание составляет исполнитель

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

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

    Это не значит, что клиент исчезает и появляется в самом конце, чтобы написать: «Збс, одобряю». Он тоже должен участвовать в процессе:

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

    Пишите однозначно и точно

    Этот совет вытекает из главной цели техзадания - «Убедиться, что клиент и исполнитель правильно поняли друг друга».

    В техническом задании не должно быть качественных прилагательных: красивый, надежный, современный. Их нельзя однозначно понять. У каждого свои понятия красоты и современности.

    Посмотрите. Кто-то ведь посчитал этот дизайн красивым и разрешил использовать на своем сайте:

    То же самое - с невнятными формулировками, которые ничего сами по себе не значат:

    • Сайт должен понравиться заказчику. А если у него будет плохое настроение?
    • Сайт должен быть удобным. Что это значит? Удобным для чего?
    • Сайт должен выдерживать большие нагрузки. 10 тысяч посетителей? Или 10 миллионов?
    • Качественный экспертный контент. Ну, вы поняли.

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

    • Сайт должен загружаться быстро → Любая страница сайта должна иметь больше 80 баллов в Google PageSpeed Insights.
    • Большие нагрузки → 50 тысяч посетителей одновременно.
    • На главной странице выводится список статей На главной странице выводится список последних 6 опубликованных статей.
    • Минималистичный удобный интерфейс подписки → Поле «Оставьте e-mail» и кнопка «Подписаться» → *нарисованный эскиз*.

    С формулировками разобрались, давайте пробежимся по структуре.

    Укажите общую информацию

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

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

    Поясните сложные термины

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


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

    Представьте, что вы 2 месяца делали крутой сайт. Каждый этап согласовывали с клиентом - он в восторге. И вот пришло время сдавать работу. Вы показываете админку, а клиент кричит: «Это что такое? Модэкс?! Я думал, вы сделаете на «Вордпрессе»!»

    Чтобы таких проблем не было, опишите используемые инструменты, движки и библиотеки. Заодно укажите требования к хостингу. Мало ли, вы сделаете на PHP - а у клиента сервер на.NET.

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

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


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

    Укажите структуру сайта

    До начала отрисовки дизайна и верстки вам нужно согласовать с клиентом структуру сайта.

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

    Можно показать структуру списком, можно нарисовать блок-схему. Как вам удобнее.


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

    Объясните, что будет на каждой странице

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

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


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


    Распишите сценарии использования сайта

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

    • Действие пользователя.
    • Ответное действие сайта.
    • Результат.


    Конечно, если вы делаете стандартную визитку или лендинг, писать сценарии не нужно. Но если на сайте будут какие-то интерактивные сервисы - очень желательно.

    Подробнее о сценариях использования читайте в «Википедии ».

    Определите, кто отвечает за контент

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


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

    Указать, что весь контент должен быть уникальный, - это полезно. Еще одна защита клиента от недобросовестных исполнителей.

    Опишите дизайн (если сможете)

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

    Писать про красивый и современный дизайн не надо. Это ничего не значит, не имеет силы и вообще фу.


    Вместо вывода: структура техзадания

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

    • Информация о компании и целевой аудитории, цели и задачи сайта.
    • Глоссарий терминов, которые могут быть непонятны клиенту.
    • Технические требования к верстке и работе сайта.
    • Описание используемых технологий и список требований к хостингу.
    • Подробная структура сайта.
    • Прототипы страниц или описания элементов, которые должны на них быть.
    • Сценарии использования нестандартного интерфейса (опционально).
    • Список контента, который делает разработчик.
    • Требования к дизайну (опционально).
    • Правила составления Software Requirements Specification. SRS - следующая ступень эволюции техзадания. Нужна для больших и сложных проектов.
    • Стандарты и шаблоны ТЗ на разработку ПО. Описания разных ГОСТов и методологий создания технических заданий.

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

    Комментарии разработчиков

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

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

    ТЗ составляет менеджер проекта после общения с клиентом и обсуждения задачи с дизайнером.

    Крупные заказчики часто просят очень подробные ТЗ, в которых описана каждая кнопка. Небольшие компании наоборот не любят дотошные документы на 100 страниц. Долго читать и легко упустить что-то важное. Чаще мы делаем лаконичные ТЗ на 10–15 страниц.

    Мы указываем:

    • Информацию о компании и цель сайта.
    • Требования к дизайну, цветовую гамму.
    • Используемые технологии и CMS.
    • Кто занимается контентом - мы или клиент.
    • Структуру сайта вплоть до каждой страницы.
    • Описания каждой страницы. Мы не делаем прототипы, но указываем, какие элементы должны быть на странице, и как они должны работать.

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

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

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

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

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

    По своему объему ТЗ может быть достаточно большим документом. Web-компании часто предлагают помощь по составлению ТЗ отдельной услугой, как правило 10-20% от стоимости всей разработки сайта.

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

    Чем детализированнее ТЗ (в разумных пределах конечно), тем лучше для обеих сторон — как для клиента, так и для исполнителя работы. В выигрыше так сказать оба:
    — клиент будет уверен, что все задуманное им в проекте четко прописано и должно быть реализовано в соответствии с ТЗ.
    — исполнитель – застрахован от множества мелких или крупных корректировок и доработок, опять же опираясь на то самое ТЗ.

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

    • Простая истина — чем сложнее проект, тем детализирование должно быть ТЗ.
    • Среди возможных вариантов можно назвать ТЗ, описывающее главные страницы интерфейса со всей совокупностью элементов на ней и описанием их поведения. Или же это может быть лаконичное описание нескольких страниц для сайта-визитки и т.п.
    • В ТЗ для программиста не должен упоминаться дизайн элементов или звучать пожелания по дизайну. Задание все-таки для программиста..
    • Описания задач в отдельных частях ТЗ должны быть граничными. Что это значит? Нужно четко обозначать конец конкретного пункта задания. В ТЗ не должно быть абстрактных фраз типа «должна быть удобная навигация». Это все субъективные признаки – одним удобно, другим не удобно и понять выполнен ли данный пункт бывает сложно из-за нечеткости положений ТЗ. Т. е. это необходимо контролировать.
    • Для несложных сайтов, где нужно описать какой-нибудь функциональный модуль, чтобы заново не изобретать велосипед, нужно проанализировать сайты с похожим функционалом, так сказать, провести анализ конкурентов; сохранить гиперссылки на страницы с требуемыми элементами интерфейса и функциями, и включить их в ТЗ с расширенными пояснениями о том, что именно делать. Также необходимо в обязательном порядке снять скриншоты с нужных страниц на случай, если сайт через время будет не доступен. При этом можно ставить свои пометки на изображениях (благо средств сейчас много для этого — Clip2net, Joxi, Awesome Screenshot и прочие).
    • Если дизайна для страниц нету или он не так важен в рамках какого-то проекта, скажем, заказчик решил сэкономить на дизайне админ-панели сайта, в этом случае программист вполне может использовать прототипы.

    Справка

    Прототип — это графическая схема размещения элементов интерфейса. Грубо говоря, нарисованная в специальной программе страница со всеми элементами.

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

    Из популярных можно выделить:
    — среди бесплатных: iPlotz, MockFlow, Mockup Builder, Cacoo;
    — среди платных: Creately, ProtoShare, Adobe Fireworks,Axure . Возможностей в общем много - выбирай, осваивай, рисуй…

    Общая структура ТЗ. От абстракции к конкретике

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

    1. Общая информация о сайте.
    2. Функциональное назначение сайта.
    3. Понятия и термины
    4. Описание модулей сайта
    5. Функциональные характеристики
    6. Описание страниц.
    7. Резервирование и надежность.
    8. Хостинг для сайта.

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

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

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

    4. Описание модулей сайта
    Этот раздел включает список модулей, которые используются на сайте. Это вполне например может быть упоминаемая выше форма обратной связи (ФОС). Но, что очень важно — нельзя просто писать «Должна присутствовать ФОС». Каждая сущность требует определения своих атрибутов! В данном случае атрибуты могут быть такими:

    • Поле «Ваш имя»;
    • Поле «Ваш е-mail»;
    • Поле «Ваш вопрос»;
    • Поле ввода капчи для защиты от спам-роботов.

    И все это должно быть четко прописано, что бы потом не возникло вопросов: «…а где перечень выбора категории вопроса? » или что-то в этом роде.

    5. Функциональные характеристики
    Сюда можно отнести, например, список браузеров, где сайт должен корректно отображаться и работать. Например, некоторые заказчики могут требовать, что бы их сайт работал корректно и в небезызвестном Internet Explorer 6, что бы не терять хоть и небольшую, но долю возможных посетителей.
    Если планируется делать высоконагруженный сайт – это тоже нужно указывать. Высоконагруженный сайт требует другого подхода при разработке и по настройке сервера.

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

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

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

    Остальные страницы

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

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

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

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

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

    Удачных Вам проектов и человеческого взаимопонимания!

    Поделиться: