Круг обязанностей должен быть понятен всем участникам. Технические термины и сокращения должны объясняться простым языком — используйте для этого инфостили. Создайте глоссарий и поместите его в начало документа.
Как составить ТЗ: даем подробную инструкцию
Сегодня рассмотрим такое понятие, как ссылочные термины. Что это такое? Как правильно их развивать? На что стоит обратить внимание? Ответ на эти вопросы важен, поскольку от него во многом зависит результат выполнения задания.
Если задание не сформулировано точно, оно будет выполнено соответствующим образом. Идеи подрядчика не всегда совпадают с идеями заказчика. Поэтому эта статья о том, как сформулировать свои требования и пожелания.
Почему разработка технического задания так важна
Не следует недооценивать важность АД. Этот документ по важности сравним с договором, в котором прописаны обязательства всех сторон, участвующих в сделке.
Техническое задание на разработку проекта можно описать как руководство по реализации проекта. Поскольку структура ТК подразумевает фиксацию всех условий процесса и деталей результата, сотрудничество становится более понятным, удобным и безопасным как для заказчика, так и для исполнителя.
Причина этого в том, что ТС подробно описывает каждый нюанс и точно объясняет каждую деталь. В результате практически не остается места для ошибок, проступков или мошенничества, поскольку любое нерегулируемое действие считается нарушением инструкций.
Но даже не это является главным преимуществом интегрированного TAP, а то, что профессиональный подход гарантирует качественный результат. Чтобы разработать продукт, который идеально работает и соответствует всем нормам и требованиям, важно позаботиться о деталях, которые тщательно просчитываются и продумываются. И даже основные требования технической спецификации требуют тщательного внимания к каждому этапу процесса.
Ошибочно думать, что этот подход применим только к сложным процессам. Даже самые простые задачи требуют четких инструкций, а все движения должны быть рассчитаны на три шага вперед. По этой причине разработка ТЗ является необходимым этапом любого проекта.
О стандартах написания технических заданий
Даже те, кому регулярно приходится ставить задачи своим сотрудникам, не знают, как составлять ТЗ. Самые важные требования — это продуманная, четкая и полная передача необходимой информации. Однако без должного опыта трудно реализовать концепцию, основываясь только на вышеперечисленных требованиях. Для написания комплексной работы необходимо знать стандарты разработки TIS, которые считаются общими и действительными для всех рабочих областей.
Некоторые профессии даже требуют от соискателей знания ГОСТ 34 и/или ГОСТ 19 при приеме на работу. Это относится, например, к таким профессиям, как технические писатели или системные аналитики. Это государственные стандарты, которые успешно используются в качестве стандарта для разработки и составления TSI.
Важно отметить, что приведенные выше ГОСТы относятся непосредственно к программным системам, поэтому вы можете использовать их в качестве стандарта для справочных терминов при разработке программного обеспечения и аналогичных продуктов.
Многие удивятся, узнав, что ГОСТ 19 действует с 1980 года. Однако, поскольку модель программного обеспечения существенно не изменилась, актуальность этого стандарта сохраняется и сегодня.
Как и большинство других отраслей, этот сектор имеет свои основные принципы, которые остаются неизменными с течением времени и с развитием новых технологий.
TSI для разработки программного обеспечения должен включать следующие пункты:
- Введение
- Основа для разработки программного обеспечения
- Основа для разработки программного обеспечения
- Основание для определения сферы применения
- Обязательная документация и требования к программе
- Технические и экономические параметры
- Этапы разработки программного обеспечения и их последовательность
- График и детали приемки и тестирования окончательного программного обеспечения.
- Приложения
ГОСТ 34 был принят на 10 лет позже, чем описанный выше стандарт. Он не сильно отличается от своего предшественника, но имеет свои особенности. Пример подготовки спецификаций требований в соответствии с данным документом выглядит следующим образом:
- Общая информация о системе
- Назначение системы
- Информация об оборудовании, для которого создается система
- Основные требования к конечному продукту
- Фазы работы и характеристики каждой фазы
- Процесс приемки конечного продукта
- Этапы подготовки системы к вводу в эксплуатацию
- Требования к программной документации
- Источники для развития
Нельзя сказать, что современные ТСИ написаны исключительно по этим образцам — время внесло свои коррективы, появилось много новых правил и рекомендаций. Однако эти документы, безусловно, могут быть использованы в качестве основы для написания спецификации по ГОСТу. Полное соблюдение этих требований необходимо только в случае сотрудничества с государственными органами.
Для составления технического задания для международных проектов применяется стандарт ISO/IEC/IEEE 29148:2018, разработанный Международной организацией по стандартизации (ISO), который, как и ГОСТ, содержит эталонные условия для составления полного и качественного технического задания. Международные справочные термины включают:
- Описание системы или продукта. Для кого предназначен предмет и что пользователь может с ним делать.
- Технические особенности: Производительность программного обеспечения, интерфейс, безопасность и т.д.
- Описание этапов тестирования.
- Приложения и история изменений в проекте.
Из этих вопросов родились «10 команд TOR». Я рассматривал ТЗ не как документ (артефакт), а как часть производственного процесса, и все стало ясно.
Зачем нужно Техническое задание?
Многие разработчики часто недооценивают важность ссылочных терминов, но ссылочные термины являются важным, можно сказать краеугольным документом при разработке информационных систем, веб-сайтов, технических систем и всего остального. Сегодня, когда в моде гибкость, может показаться, что ТЗ — это лишний документ, но это верно только в том случае, если вы сталкиваетесь с разработкой действительно серьезных информационных систем, крупных программных продуктов или порталов. Объяснить на пальцах, что вы хотите, чтобы клиент мог делать, если система содержит 3-5 сущностей — проблема, но если их гораздо больше, то вы обязательно что-нибудь забудете. Затем он начинает рисовать на листе бумаги, писать на салфетках в кафе, писать сообщения в WhatsApp: «Но было бы здорово, если бы в правом углу были синие иконки, которые при наведении на них мыши перемещаются в центр и увеличивают масштаб! Чтобы формализовать этот процесс, создаются командные условия, то есть документ о том, как все должно быть. Командные условия выполняют ряд важных функций:
- Он сообщает клиенту и разработчику, какой должна быть система и что она должна делать.
- Это защищает разработчика от внезапного появления новых требований, т.е. разработчик должен сделать все, что указано в ТЗ. Если клиент хочет иметь в программе другую функцию, разработчик должен заплатить за нее отдельно и написать для нее отдельное описание услуги.
- Это защищает клиента от лени и некомпетентности разработчиков, т.е. программа должна выглядеть именно так, как написано в ТЗ. Заказчик может предъявить претензии к подрядчику на основании ТЗ.
При разработке системы обратите внимание на подготовку спецификаций! Это избавит вас от проблем.
Кто составляет ТЗ?
Спецификация требований — это работа команды людей, а не одного человека:
- Аналитики на стороне клиента, которые определяют потребность в системе и представляют письменные требования к новому проекту.
- Аналитики на стороне разработчика — им необходимо рассмотреть область, в которой будет разрабатываться программа или бизнес. Рассмотрите все шаблоны, алгоритмы и нюансы работы, которую должна выполнять система.
- Технический писатель — сотрудник, который собирает все данные от аналитиков и записывает их в соответствии с ГОСТом.
В большинстве случаев техническое задание, подготовленное в соответствии с ГОСТом, является требованием государственного сектора или крупных государственных предприятий. Подготовка ТЗ является длительной и сложной задачей. ТЗ не раз согласовывается руководством клиента и разработчиком, не раз корректируется и переписывается. Написание хорошего ТЗ иногда занимает месяц или больше, но лучше потратить больше времени на написание спецификации требований, чем потом доказывать, что вы не так поняли и имели в виду что-то совершенно другое. Кроме того, каждая ошибка в ТЗ стоит разработчику/клиенту денег и времени.
По каким ГОСТам пишется ТЗ?
Конечно, спецификация задачи может быть написана в любом порядке, и если клиент — не форматер, не крупная компания, которая придерживается стандартов и не принадлежит государственным структурам, то этого вполне достаточно.
В России форматирование задач осуществляется в соответствии с двумя ГОСТами:
Для создания модуля, программы или серии программ требуется спецификация государственного стандарта. Это очень важно, потому что здесь описаны все моменты, по которым впоследствии могут возникнуть разногласия.
Какой ГОСТ для Технического задания выбрать?
Если вы разрабатываете документацию для программы, созданной для конкретной компании, стандартом является ГОСТ 34. Если вы пишете документацию для массовой программы, стандартом является ГОСТ 19.
Можно ли выбрать ГОСТ 34 для воспроизводимого программного продукта и ГОСТ 19 для системы для конкретной организации? Да, можно, если клиент по каким-то причинам настаивает на этом. Во всех остальных случаях лучше выбрать нужный ГОСТ, так как параграфы ГОСТ отличаются.