Чтобы упростить коммуникацию с заказчиком и сократить процесс первичных согласований, используют проектную документацию. Это расширенный вариант технического задания, где основные этапы подготовки к реализации проекта представляют клиенту в виде изображений и схем, а результат обсуждений фиксируют в классическом текстовом варианте.
С чего начинается проектная документация, почему визуальные схемы работают лучше текста, как наличие прототипов проекта влияет на уровень эмпатии клиента, рассказал Виталий Арбузов, CEO digital-агентства INPRO.digital.
Почему проектная документация упрощает разработку проекта
Проектная документация делает процесс согласований проще для обеих сторон. Вы сэкономите свое время на объяснении терминов, а клиенту не нужно будет вычитывать десятки страниц ТЗ. Визуализация на этапе согласования помогает:
- cнизить риски в ходе самого проекта. Когда веб-разработка уже будет в активной стадии, вам нужно будет пройти еще несколько этапов утверждения. Если на стадии обсуждения вы придете с заказчиком к консенсусу, то вероятность того, что все придется переделывать в середине работы будет сведена к минимуму;
- упростить и декомпозировать комплексные задачи. Управление проектом с помощью фасилитации — одно из ключевых преимуществ проектной документации. Результат становится наглядным, поэтому и согласование с клиентом проходит легче и команда более четко понимает стоящие перед ней задачи и ожидаемый итог работы;
- выстроить нормальные отношения с клиентом. Уровень взаимопонимания с заказчиком напрямую влияет на успешность вашего проекта, скорость и качество его реализации. Общение на равных за счет упрощения и визуализации поможет вам на следующих этапах разработки быть более мобильными в принятии решений и одновременно даст больше возможностей для дополнительных продаж, так как вы будете лучше понимать, что именно необходимо для функционирования ресурса.
С чего начать составление проектной документации
Перед тем как приступать к созданию проектной документации и разработке первых вайрфреймов, изучите рынок. Даже если это напрямую не прописано в договоре с клиентом, сделайте базовый ресерч по основным конкурентам: как работает интерфейс, какие страницы есть, как расположено меню. Выпишите опции и функционал, которого нет у вашего заказчика. Обсудите их вместе, акцентируя внимание на следующих аспектах:
1. Хочет ли клиент добавить на сайт такую же функцию?
Всегда помните, что заказчик не должен быть силен в технических терминах. Ваша задача на данном этапе — объяснить ему, какую задачу с точки зрения бизнеса решает каждый функциональный модуль, который есть на сайте у конкурентов.
2. Нужна ли бизнесу клиента данная функция?
Поговорите с клиентом о его ожиданиях от изменений сайта: нужен ли этот функциональный модуль с точки зрения продаж, улучшит ли он качество сервиса, соответствует ли набору доступных услуг? Например, если у вашего заказчика интернет-магазин, где доставка осуществляется только через курьерскую службу, то ему точно не нужен модуль с вариантами выбора пунктов самовывоза на карте. Даже если он есть у всех конкурентов.
3. Насколько сильно добавление этой функции повлияет на смету и сроки проекта?
Еще на этапе обсуждения дополнительного функционала расскажите клиенту о том, как это может повлиять на ход проекта. Например, если заказчик хочет сделать личный кабинет, как у конкурентов, объясните, что бюджет на реализацию этого блока может быть больше, чем сумма всего проекта на текущий момент, а сроки увеличатся в несколько раз.
Не забудьте проверить на прочность и текущий сайт вашего заказчика. Мы для этого часто привлекаем асессоров, то есть людей, которые тестируют сайт по нашей просьбе. Если будете делать такой вариант аудита, внимательно отнеситесь к подбору людей. Если это интернет-магазин женской косметики, нужно искать именно тех, кто будет его целевой аудиторией.
Разработайте для них анкету или опросник, которую они должны будут заполнить после использования ресурса. Это позволит выявить баги, слабые стороны, недостающие функциональные модули. Проанализируйте полученные данные и сформируйте из них интуитивно понятную схему, которая станет частью проектной документации.
Схематичная визуализация результатов асессорского аудита
Кто входит в команду разработки проектной документации
За разработку проектной документации отвечает проектный менеджер. Он есть на любом проекте вне зависимости от специализации продукта клиента или масштаба задачи. Проектный менеджер выступает как контролирующий орган, а именно:
- Ведет всю коммуникацию с клиентом. Даже если вы привлекаете других специалистов для разработки проектной документации, постарайтесь сделать так, чтобы напрямую с заказчиком общался только кто-то один. Так клиенту не придется запоминать несколько имен, дублировать информацию и объяснять свои пожелания по нескольку раз. Проектный менеджер коммуницирует с клиентом, записывает ключевые идеи и передает их своей команде.
- Контролирует деятельность сотрудников, работающих над проектом. Проектный менеджер отвечает за то, чтобы все было сделано в срок, все комментарии отработаны, а обратная связь отправлена. В его задачи входит и мониторинг деятельности команды: он выстраивает коммуникацию между специалистами, следит за всеми чатами, отвечает на любые вопросы.
- Согласовывает все этапы работ. Все специалисты отправляют свои наработки сначала проектному менеджеру, он вносит правки и только после этого отправляет макеты на согласование клиенту.
На сложных проектах еще на этапе первичных согласований к проектному менеджеру подключаются бизнес-аналитик и дизайнер. Бизнес-аналитики начинают свою работу с изучения рынка и анализа текущей ситуации по проекту.
Имейте в виду, что если для визуализации вам нужны только схемы, то не обязательно привлекать дизайнера. Достаточно выбрать интуитивно понятное приложение, где сам аналитик сможет отрисовать простейшие макеты и указать взаимосвязи между объектами. Мы пользуемся общеизвестной платформой Figma для комплексных проектов и Miro, если основная часть работ — простые схематичные изображения.
Например, на этапе разработки проектной документации всегда создается структура сайта — это ключевой момент при согласовании с клиентом. По факту это выглядит как детализированная схема с комментариями или прототипами отдельных элементов. С таким вариантом обычно может справиться бизнес-аналитик самостоятельно.
Визуализация структуры сайта
Подключите дизайнера, если вы планируете разработать прототипы или визуальную концепцию. В таком случае важно будет не только показать взаимосвязи, но и определить общую дизайн-концепцию, показать, как будет выглядеть проект в итоге. Мы мыслим образами, поэтому здесь внешний вид будет играть ключевую роль. Даже если вы не сразу согласуете функциональные модули с красивыми и аккуратно оформленными прототипами, процесс обсуждения будет идти легче и комфортнее.
Примеры вайрфреймов
За время своей работы с таким подходом, мы поняли, что клиент больше всего ценит, когда уважают его время и ресурсы. Он делает свое дело: развивает бизнес, занимается предпринимательством. И ему просто нужен качественный ресурс для реализации своих идей.
Ваша задача — помочь ему в достижении его цели, а не продемонстрировать экспертизу по всем аспектам веб-разработки. Постарайтесь понять глубинную боль заказчика, будь то нелояльные клиенты, низкая конверсия или непрогнозируемые риски. Если вы увидите и предложите решения этих проблем, то в скором времени заказчик станет вашим союзником и партнером.
Фото на обложке: CoffeeMate/Depositphotos.com
Если вы заказываете у сторонних подрядчиков проект, в котором нет жестких стандартов качества, попробуйте работать по техническому заданию. Оно поможет в разработке сайта, дизайна, написании статей в блог или оказании других маркетинговых и IT-услуг. ТЗ конкретизирует пожелания.
Рассказываем, как составить ТЗ так, чтобы вас поняли, что в него стоит добавить, кто должен оформлять этот документ и какие есть нюансы и особенности.
- Что такое техническое задание
- Когда стоит составлять техническое задание
- Кто должен составлять техническое задание
- Сколько стоит заказать ТЗ
- Как написать техническое задание
- Шаблоны и примеры ТЗ
- Когда ТЗ не нужно
- Кратко — универсальные советы по составлению ТЗ
Что такое техническое задание
Техническое задание, или ТЗ — это документ, в котором фиксируются требования к проекту. Условно ТЗ можно назвать любое поручение исполнителю, главное, чтобы в нем были ясно прописаны характеристики итогового продукта.
| Это не ТЗ, а поручение | Сходи, купи хлеба |
| Вот это ТЗ | Мне нужен хлеб:
Другой хлеб мне не нужен. |
В первом примере мы даем поручение, которое исполнитель должен выполнить по своему усмотрению. Во втором явно указываем, что именно нам нужно. Идеальным решением во втором случае еще будет составление договора, чтобы техническое задание стало приложением к нему.
Когда стоит составлять техническое задание
Всё зависит от проекта и вашей бизнес-модели. Если проект маленький, вы доверяете исполнителю, и риск получить не то, что вы хотели, мал, можно обойтись устным поручением.
Если проект требует значительных для вас вложений, он связан со сложной IT-сферой, где много нюансов из-за особенностей технологий, или с творческой сферой, стоит зафиксировать требования в ТЗ.
- Вы проверяете отношение исполнителя к делу. Например, приходите к подрядчику без ТЗ, а он не пытается узнать подробности задачи и выяснить, что конкретно вам нужно. Это грозит потенциальными проблемами с результатом.
- Вы страхуетесь от недобросовестных подрядчиков. Если есть техническое задание, качество заказанного продукта можно проверить на соответствие требованиям — это аргумент для спорных ситуаций.
- Проще менять исполнителей. Разработка большого проекта, например, сайта или приложения, может длиться несколько лет. Если на старте вы поняли, что подрядчик не справляется, при наличии ТЗ проще отказаться от его услуг и найти нового. Экономя время на уточнение требований.
Кто должен составлять техническое задание
Устоявшейся практики нет — как договоритесь с подрядчиком.
Заказчик делает сам
Например, гендиректор студии архитектурной фотографии «АрхФото» Анатолий Шостак называет идеальным заказом ситуацию, когда заказчик сразу присылает подробное ТЗ и просит оценить работы.
В таких случаях мы точно знаем, что, как и когда нужно снимать. Соответственно, можем сразу рассчитать стоимость и сроки работ. Но в большинстве случаев заказчики не имеют точного ТЗ, потому что у них нет конкретного понимания, что именно нужно требовать от исполнителя. В таких случаях мы предлагаем им заполнить форму с наводящими вопросами.
Анатолий Шостак
Гендиректор «АрхФото»
Совместная работа
Процесс может выглядеть так: заказчик формулирует все требования к будущему продукту, заполняет бриф подрядчика по образцу, а затем на интервью согласовываются нюансы.
Техзадание полностью делает исполнитель
В таких ситуациях подрядчику ставится общая задача, а требования и обязательные функции к продукту он собирает с помощью разных источников — проводит интервью сотрудников заказчика, изучает потенциальных потребителей и конкурентов.
Совместная работа по составлению ТЗ и заказ задания исполнителю отличается в первую очередь подходом. Например, вы хотите заказать интернет-магазин:
- Совместная работа. Вы говорите исполнителю, что хотите сайт с аккуратным отображением на любых устройствах, с возможностью регистрации личного кабинета и сбора баллов. Подрядчик уточняет, долго ли хранятся баллы, как их будут использовать. И оформляет ТЗ в документ.
- Делает исполнитель. Вы ставите задачу — сделать интернет-магазин. Исполнитель с помощью бизнес-аналитика собирает и структурирует ваши требования к магазину, а также изучает конкурентов и целевую аудиторию, предлагает добавить в ТЗ требование отображать сайт на телевизорах — потому что ваши покупатели часто заказывают товары именно так.
Универсального решения нет, но лучше доверять составление ТЗ представителю подрядчика — специалист лучше знает, как должен работать его проект. Но при этом не стоит отстраняться от работы — объясните подрядчику, зачем вам продукт, как вы планируете его использовать, кто и зачем им будет пользоваться, покажите примеры решений конкурентов, которые вы считаете хорошими.
Сколько стоит заказать ТЗ
Если проект сложный, с большим списком функций и требований, техническое задание можно заказать за деньги. Это практикуется при создании сайтов и мобильных приложений. С готовым ТЗ можно не искать исполнителя самостоятельно, а открыть тендер.
Основатель компании по разработке информационных систем Work Solutions Максим Мул при заказе ТЗ рекомендует ориентироваться на 10-20 % от общей стоимости разработки продукта.
Не рассчитывайте получить качественное ТЗ бесплатно. Для его составления привлекают аналитиков, которые должны сформировать функциональные требования исходя из задач бизнеса и описать их так, чтобы не было пространства для двусмысленных толкований.
При этом ТЗ — это отчуждаемый документ, с которым может работать любой исполнитель. То есть вы можете заказать ТЗ у одних разработчиков, а затем обратится к другим. Главное, чтобы в ТЗ были описаны бизнес-логика и правила работы.Максим Мул
Основатель Work Solutions
Если речь про IT-задачи, например, интеграцию между информационными системами, внедрение CRM, разработку дополнительного функционала ПО или приложения по API, то не стоит рассчитывать на ТЗ стоимостью меньше 50 000 руб., считает гендиректор компании «Информатика и Сервис» Владимир Севрук.
Чтобы составить минимально ценное для клиента и понятное разработчикам ТЗ, аналитику нужно потратить минимум одну неделю на опрос всех сотрудников клиента, уточнить возможность реализации требований с разработчиками и в итоге свести всё в один документ.
Такие затраты микро- и малый бизнес в основном не могут себе позволить — заказ ТЗ актуален для верхнего малого и среднего бизнеса, когда IT-продукт в итоге существенно сократит расходы бизнеса и это будет выгодно.Владимир Севрук
Гендиректор компании «Информатика и Сервис»
Платные подробные ТЗ применяют и в других сферах. Например, в архитектурной фотографии.
У нас есть более сложная форма ТЗ — мы называем ее «сценарий». Для сценария мы проводим предварительные съемки, прописываем и согласовываем все ракурсы с заказчиком, прорабатываем целевую аудиторию и рассчитываем тайминг каждого кадра с учетом движения солнца. И все это ещё до начала чистовой работы.
Анатолий Шостак
Гендиректор «АрхФото»
За составление такого подробного сценария в «АрхФото» берут деньги. В зависимости от сложности проекта и требований заказчика сценарий иногда стоит дороже самой съемки. Зато благодаря ТЗ заказчик еще до начала работ понимает, что получит в итоге, говорит Анатолий Шостак.
Как написать техническое задание
Что конкретно стоит добавить в техзадание, зависит от продукта. Например, если вы заказываете партию одежды, нужно прописать особенности покроя, виды материалов и их качество, вплоть до примерной матовости поверхности пуговиц.
Если заключаете договор на разработку сайта, нужны сценарии его использования.
Пишите однозначно
Составляя ТЗ или описывая продукт подрядчику, старайтесь избегать качественных прилагательных. «Красивый» пиджак для одного человека будет приталенным, а для другого, наоборот, широкого покроя. Так и с любыми проектами: чем больше конкретики, тем лучше.
Хороший подрядчик будет конкретизировать и уточнять неоднозначные строчки в ТЗ, но это потребует дополнительного времени на переделку. Поэтому лучше стараться минимизировать недопонимание. И постараться определить для себя конкретные требования к продукту еще до разговора с исполнителем.
Бывает, что заказчик не знает, что конкретно хочет получить, причем часто сам того не осознавая. Из-за этого в ТЗ появляются расплывчатые и многословные формулировки. В итоге заказчик с исполнителем потратят значительное время на их уточнение. Эффективнее сделать ТЗ с конкретными и точными требованиями, без многословности.
Алексей Орлов
Руководитель проектов компании «Рексофт»
Стоит попробовать любые пожелания сводить к количественным требованиям.
| Не подходит | Подходит |
| Выводить на главной странице сайта популярные товары | Взять самые покупаемые товары за неделю и показывать их на первом экране сайта в блоке популярных товаров. С возможностью добавить товар в корзину за один клик. |
Дайте подрядчику общую информацию
Расскажите подрядчику, чем занимается компания, кто ее целевая аудитория, поделитесь нюансами работы — это поможет исполнителю лучше вникнуть в проект и избежать ошибок.
Гендиректор INOSTUDIO Максим Болотов рекомендует как минимум озвучить подрядчику идею проекта, который вы заказываете, уточнить, в чем его конкурентные преимущества и уникальность.
Расскажите подрядчику, какие задачи будет решать IT-решение. Это может быть увеличение прибыли, повышение узнаваемости бренда, лояльности пользователей. Уточните, кто будет пользователями продукта, их социальные и поведенческие характеристики, например, пол, возраст, интересы, семейное положение, потребности — это нужно, чтобы корректно и эффективно сформулировать функциональные требования к продукту.
Максим Болотов
Гендиректор INOSTUDIO
Помогите разобраться в терминах и нюансах
Подрядчик, как правило, специалист в своей отрасли, в вашей сфере он по умолчанию разбирается хуже. Поэтому помогите ему понять специфические термины или нюансы в техзадании.
Можно ввести отдельный раздел в виде словаря с расшифровкой или пояснять по ходу документа.
Покажите конкурентов
В ТЗ стоит добавить ссылки на аналогичные проекты и дополнить их описаниями: что конкретно нравится в аналогах, что стоит повторить, а чего точно стоит избегать.
Если заказчик планирует создать продукт, идея которого уже есть на рынке, то имеет смысл изучить конкурентов. Выявить отличительные особенности их IT-решений, чтобы разработать собственное с уникальными преимуществами.
К документу с видением продукта рекомендуем прикладывать ссылки на аналогичные решения. С описанием функциональных блоков, которые вам понравились. Это упростит дальнейшее общение с подрядчиком.Максим Болотов
Гендиректор INOSTUDIO
Уточните важные технические требования
Если вы делаете IT-продукт, стоит сразу согласовать все технические требования с вашим IT-специалистом и подрядчиками. Это необходимо, чтобы новое решение могло быть интегрировано в ваши имеющиеся платформы и бизнес-процессы.
Например, если вы заказываете интернет-магазин, важно, чтобы его движок мог принимать данные из всех ваших систем — не только обмениваться актуальными ценами с 1С, но и получать информацию из CRM и самописных сервисов.
О нюансах нужно предупреждать подрядчика еще во время обсуждения общего видения проекта и до составления ТЗ. Важно, чтобы исполнитель умел работать со всеми вашими технологиями.
Распишите сценарии использования продукта
Если вы делаете что-то стандартное, то так сильно погружаться в особенности продукта не стоит, это лишь запутает и добавит ТЗ многословности. Но в случае чего-то необычного попробуйте в техзадании отвечать не на вопрос «Что?», а на вопрос «Как будет делать пользователь?».
- Плохо — «Требование 1. На сайте есть корзина, пользователь по дополнительному запросу может получить список дополнительных товаров». В этом случае непонятно, что и как должно работать.
- Хорошо — «Когда пользователь заходит в корзину, сайт показывает ему всплывающий баннер. На этом баннере должны быть товары, которые могут пригодиться покупателю. Он может одним кликом добавить любой товар к заказу. Или закрыть окно». В этом случае понятно, как работает сценарий использования корзины и блока с кросс-товарами.
Если речь про IT-продукты, можно прописывать сценарии по такому шаблону:
- действие пользователя;
- ответ сайта;
- если пользователь делает так, то сайт делает так;
- если пользователь делает по-другому, то сайт отвечает так.
Опишите требования к проверке проекта
При составлении ТЗ отталкивайтесь не от абстрактных требований к продукту, в таком случае получится многословный и неструктурированный список желаний. Попробуйте вместо этого придумать условный чек-лист, по которому вы будете проверять успешность проекта.
Например, для интернет-магазина это может быть:
- Буду проверять корректное отображение в браузерах Chrome, Firefox, Mozilla трех последних версий.
- Отображение на экранах мобильника с разрешением 320 px на 480 px, монитора с разрешением 1024 px на 802 px, большого монитора с разрешением…
- Скорость разгрузки по сервису такому-то не больше 1 секунды.
Чем подробнее и длиннее чек-лист, тем лучше.
Двигайтесь от общего к частному
Старайтесь собирать требования к продукту от общего к частному. Если вы заказываете дизайн сайта, то сначала стоит рассказать про общую концепцию и пожелания по цветовой гамме. Затем рассказать, какие страницы должны быть на ресурсе. После перейти к описанию требований к каждому блоку на каждой странице. И в конце определиться с элементами в блоках: какой вид и размер шрифта должен быть у текста, как оформляются иллюстрации.
Шаблоны и примеры ТЗ
Универсального шаблона технического задания нет — требования будут отличаться в зависимости от отрасли и типа проекта.
Если вы решили составлять ТЗ самостоятельно, эффективнее попросить шаблон или пример у подрядчика. Или поискать брифы, которые предлагают заполнить исполнители у себя на сайтах — вопросы из таких форм можно использовать как разделы ТЗ.
Если планируете заказать IT-продукт, можно использовать за основу госстандарты. Например:
- ГОСТ 34. Это еще советская разработка сбора требований для создания автоматизированных систем. Не готовый шаблон, но много вопросов к заказчику, которые помогут структурировать пожелания.
- IEEE 29148-2011 — стандарт разработки сложных систем, в которых есть вопросы о требовании к функциям, а также рекомендация описать условия программного окружения, то есть платформ, которые будут работать вместе с вашим продуктом.
- Rational Unified Process — продвинутая спецификация для разработки требований к IT-продуктам. Много внимания отводится вариантам использования.
Эффективнее будет составлять ТЗ вместе с выбранным подрядчиком. Он будет задавать вопросы, уточнять нюансы и структурировать информацию. А вы объяснять, что же вам в итоге нужно от продукта.
Когда ТЗ не нужно
Не стоит самостоятельно составлять техническое задание для любого продукта — зачастую это излишняя работа, которая только запутает и станет бесполезной бумагой для подрядчика.
Эффективнее будет начать с общего понимания задачи — подумайте, что вам нужно от продукта, как его будут использовать, что в нем должно быть, а что, наоборот, точно стоит исключить. Опишите это с использованием не качественных, а количественных характеристик.
С этим пониманием обратитесь к подрядчику. Возможно, он предложит использовать не ТЗ, а гибкие методологии создания продукта — когда сначала делают небольшой прототип, выпускают его, а затем собирают обратную связь от первых клиентов и постоянно дополняют требования на основе этой аналитики. С таким подходом проект реализуется с учетом потребности клиента.
Вместо ТЗ выгоднее сначала сделать предпроектное обследование, изучить реальные потребности клиентов, вместе с аналитиком подрядчика. А затем решать, нужно ли ТЗ вообще.
Может быть, выгоднее и эффективнее выполнять бизнес-задачу, например, с помощью SCRUM. Действуя небольшими итерациями в 1-2 недели, анализируя результат и постепенно дополняя требования.Владимир Севрук
Гендиректор компании «Информатика и Сервис»
Кратко — универсальные советы по составлению ТЗ
Составляя ТЗ самостоятельно или с подрядчиком, придерживайтесь следующих правил:
- Если у вас большой и нестандартный проект, стоит изучить цены на составление ТЗ. Возможно, выгоднее один раз заплатить аналитику за создание подробного документа и открыть тендер среди подрядчиков, чем самому искать исполнителей и делать несколько ТЗ по их шаблонам.
- Прописывайте требования однозначно, используйте количественные, а не качественные характеристики.
- Поделитесь с подрядчиком общей информацией о компании и проекте — это поможет исполнителю лучше понять целевую аудиторию продукта и не допустить ошибок.
- Составьте для исполнителя словарь терминов из вашей отрасли, которые используются в ТЗ.
- Посоветуйтесь с IT-специалистами из сторонних отделов. Добавьте в ТЗ информацию о технологиях, системах и бизнес-процессах, в которые будет интегрирован новый продукт.
- Распишите сценарии использовании — сначала действие пользователя, затем результат, который должен выдать ваш продукт.
- Опишите требования с помощью чек-листа проверки — подумайте, как бы вы стали проверять готовый продукт.
Перевод статьи «How to Write Documentation For Your Next Software Development Project».
У вас на горизонте замаячил новый проект? Наличие правильно составленной документации — важный аспект в деле обеспечения бесперебойной работы над ним.
Прежде чем приступить к проектированию, написанию кода, сборке и тестированию, уделите время подготовке всей необходимой вам документации. Это не самая захватывающая часть проекта, но она имеет большое значение.
В чем важность документации?
Сфера разработки ПО — одна из тех, которые развиваются особенно быстро. Пытаясь выдерживать темп, вы можете решить, что как только в голову пришла хорошая идея, нужно сразу браться за написание кода. Но попридержите лошадей. Попытка срезать угол на самом деле ничего вам не даст.
Работая над документацией, вы не теряете время. Напротив, вы даже сможете его сэкономить (если подойдете к делу с умом), да еще и улучшить свой продукт. По мере роста проекта документация станет руководством, позволяющим делать все правильно с первой попытки. Никаких догадок, никакой самодеятельности — сплошной профессионализм.
Если у менеджера проекта есть прекрасное понимание этого проекта и видение того, каким должен быть продукт, — это прекрасно. Беда в том, что если все это у менеджера только в голове, разработчики или новые члены команды не смогут получить доступ к этому видению и пониманию. А в процессе коммуникации некоторые детали могут потеряться.
Состояние технической документации может послужить как залогом успеха проекта, так и одной из причин его провала. Если каждый этап проекта хорошо задокументирован, работа будет продвигаться плавно и в итоге вы сэкономите время. Чтобы донести до занятых в проекте людей важную информацию, вам не придется общаться с каждым из них лично. При этом также снизится возможность недопониманий.
Зачем писать проектную документацию?
Ваш проект будет меньше зависеть от отдельных людей
Благодаря подробной документации значительно упрощается подключение к работе новых членов команды. По мере роста, изменения и масштабирования продукта вы сможете направлять новых сотрудников к необходимой документации и таким образом быстро вводить их в курс дела.
Это работает и в обратную сторону: если член команды уйдет, он не заберет с собой все свои знания о проекте. Все они останутся в документации.
Упрощается коммуникация со стейкхолдерами и клиентами
Преимущества хорошо задокументированного проекта ПО выходят за рамки внутренних процессов.
С правильной документацией также становится легче представить свой продукт заинтересованным сторонам. Все, что написано на бумаге, легче рассмотреть и понять, чем идеи в чьей-то голове.
В общем, документация продукта помогает в процессе питчинга. Но этим дело не ограничивается! Если клиент одобрил представленные вами документы, вам будет легко прибегнуть к ним при возникновении проблем. Никаких «а вот он сказал, а она сказала»: вся информация сохранена в одном месте и на нее можно ссылаться.
Наконец, успешный проект — это не только продукт, который вы создаете, но и отношения, которые вы строите. Предупреждая как можно большее число проблем, вы обеспечите команде приятную совместную работу.
Как написать хорошую документацию
Хотим отметить, что для всего вышеперечисленного вовсе не нужна документация объемом с Большую советскую энциклопедию. Вам нужно лишь проследить за тем, чтобы в ней были охвачены самые главные части и особенности вашего проекта. В этой статье мы дадим вам несколько советов, как это сделать.
Составьте перечень необходимых документов
У вас в голове уже спланирован весь проект? Это отличное начало, но лучше все же задокументируйте свой план. Если вы не видите смысла создавать какую-либо документацию для себя, помните, что вы делаете это в основном для пользователей вашего конечного продукта.
Люди заметят не только то, насколько хорошо работает ваша программа, но и то, насколько быстро она была создана, а также то, что вам не пришлось вносить кучу правок после запуска.
Какие документы вам понадобятся для этого? Это во многом определяется размерами проекта. Возможно, вам потребуется документация, которая будет служить справочником для повседневных процессов. А может, вам нужна скорее схема крупного плана картины.
Давайте разделим документацию ПО на две категории: документацию процесса и документацию продукта.
Что такое документация продукта?
Документация продукта описывает конечную цель: собственно продукт, который вы создаете. Как он работает, как с ним работать, технологические спецификации, руководства пользователя — все то, что может понадобиться, когда продукт уже будет реализован.
Для ваших разработчиков самая важная документация продукта — это системная документация. В ней объясняется, как работает программа, почему она работает определенным образом и как с ней работать.
Для пользователей вашей программы крайне важна пользовательская документация. Это учебные пособия, FAQ по устранению неполадок и, конечно, руководство пользователя, которое поможет людям использовать ваш продукт так, как вы планировали.
Что такое документация процесса?
Считайте ее дорожной картой, которая проведет ваш проект от идеи к реализации. Эта документация может включать:
- Стандарты и графики тестирования. Они помогут обеспечить единообразие в тестировании, благодаря чему результаты будут релевантными.
- Заметки с совещаний: сохраните их, чтобы иметь доказательства при спорах с клиентами.
- Планы проекта. Как вы будете строить свой продукт? На какие этапы будет разделен процесс разработки, когда вы планируете завершить работу над каждым из этапов?
Определите критически важную информацию
Что касается документации процесса, только вам решать, насколько подробно вы будете ее расписывать. Если вы опытный разработчик или руководитель проекта, вы можете предположить, какие вопросы и дискуссии могут возникнуть в дальнейшем.
Если вы новичок в этом деле, вероятно, вы и понятия не имеете, что нужно включить в документацию. Вот несколько вещей, которые вы могли упустить из виду, но которые могут ускорить разработку вашего проекта:
Соблюдение конфиденциальности
Если это релевантно для вашего продукта, создайте руководство, которое поможет вашей команде не выйти за рамки дозволенного в отношении сбора и обработки личных данных. Прежде всего, опишите требования законодательства. Распишите процедуру, следуя которой сотрудники смогут быть уверенными в своих действиях.
Планы действий в чрезвычайных ситуациях
Что делать, если упал сервер? Каковы должны быть первые шаги при обнаружении взлома системы безопасности? Что делать, если оборудование внезапно решит объявить забастовку? Если у вас будут четко прописанные ответы на подобные вопросы, это сэкономит вам много времени и денег.
Визуализация
Техническая документация — это не только слова. Люди по-прежнему лучше всего воспринимают информацию визуально. Поэтому диаграммы могут помочь вам сделать рабочие процессы более понятными.
Но визуализация того, как продукт должен работать в итоге, тоже способствует более рациональному подходу к работе. Особенно это касается сложных проектов.
Все еще не знаете, что включить в документацию? Спросите мнение заинтересованных людей. Сядьте с командой за стол и вместе решите, что они хотят видеть на бумаге. Это поможет избежать многих проблем.
Пишите технические документы эффективно
Не волнуйтесь, сейчас разберем как это сделать. Не все одарены писательским талантом и уж точно не все мы являемся прирожденными техническими писателями. Создание технических документов может показаться скучной и в то же время сложной задачей. Сложность в том, что ошибка в техническом документе может иметь очень серьезные последствия для продукта или процесса. Ошибки в руководстве пользователя тоже опасны.
Следите за языком
Не нужно стараться произвести впечатление на читателя. Члены вашей команды и так знают, что вы умный; не надо в качестве доказательства щеголять техническим жаргоном там, где это просто не нужно.
Когда речь идет о деловых документах, многих людей просто тянет использовать более сложный язык. Но при написании документации вы обращаетесь к живым людям. И у вас уже сложился какой-то стиль общения с ними, какой-то общий язык. Постарайтесь сохранить все это (стиль и язык) в письменной речи. Так ваши документы станут более понятными.
Предложения должны быть короткими. Используйте слова попроще. Старайтесь не допустить недопонимания.
Цель технической документации — объяснять непонятное и таким образом ускорять процессы. Документация не должна порождать еще больше вопросов. Особенно это касается документации, предназначенной для конечного пользователя.
Если хотите получить бонусные очки, попробуйте написать разную документацию для разных пользователей. Возьмем к примеру Python. По этому языку есть отличная документация для самых разных пользователей, от новичков до опытных профессионалов.
Организуйте свои мысли
Да, если вы планируете написать план, вам нужно спланировать его написание. Четкая структура технической документации экономит время читателей. Используйте заголовки. Упорядочивайте вещи хронологически.
Если это ваше первое родео, начните с использования готового шаблона для технического документа. Не нужно заново изобретать велосипед.
Проверьте написанное
Дайте кому-нибудь другому почитать вашу техническую документацию, чтобы убедиться, что она проста для понимания и охватывает все важные аспекты.
Слишком часто руководства пользователя рассматриваются как побочный продукт и не включаются в тестирование. И совершенно напрасно.
Облегчите себе работу над будущими проектами
Создание технической документации приносит пользу не только проекту, над которым вы сейчас работаете. Поскольку у вас уже будет наработанная схема, вам будет проще составлять документацию для всех будущих проектов. Вам нужно будет лишь внести необходимые изменения, касающиеся вашего продукта, учесть прошлый опыт и — вуаля! — вы готовы приступить к разработке.
Техническая документация – это набор документов, разработка которого необходима для любого товара, изготовление которого проходит не по государственным стандартам, а по особой процедуре. В технических условиях устанавливаются требования, которые должны быть соблюдены при изготовлении продукции, а также процедуры, с помощью которых можно проверить соблюдение этих норм.
Процесс разработки технической документации
Законодательством предписано обязательное наличие технических документов для устройств, которые будут применяться на высокоопасных производственных объектах, и для продукции, изготавливаемой не по действующему в ее отношении нормативному акту. Помимо того, документы должны иметь определенное содержание. Регламентируется оно стандартом о системе конструкторской документации.
Стандарты оговаривающие требования к выполнению документации ГОСТ 2.102, 2.601, 11442 и в целом все прочие требования ЕСКД, ЕСТД.
Орган по сертификации СЕРКОНС предлагает услуги по следующим видам разработки документов
(при необходимости все документы будут согласованы в соответствующих федеральных агентствах)
Разработка технической документации:
- Руководство по эксплуатации – документ, содержащий четкие сведения относительно конструкции, а также принципах действия и характеристиках устройства, в том числе относительно его составных частей.
- Паспорт (формуляр) технического устройства – документ, содержащий сведения, удостоверяющие гарантии изготовителя, значения основных параметров и характеристик (свойств) изделия, а также сведения о сертификации и утилизации изделия.
- Расчеты на прочность – документ, содержащий исследование, осуществляемое с целью определения безопасной эксплуатации объекта в конкретных условиях и при конкретных нагрузках.
- Технические условия – документ, устанавливающий технические требования, которым должны соответствовать конкретное изделие, материал, вещество и пр. или их группа. Кроме того, в них должны быть указаны процедуры, с помощью которых можно установить, соблюдены ли данные требования.
- И другие документы в зависимости от специфики продукта.
Технические регламенты для некоторых продуктов также можно отнести к технической документации. Технический регламент — это специальный нормативный документ, который устанавливает требования для безопасности здоровья человека, охраны окружающей среды, сохранения имущества и т. д.
В случае если организация, которая утверждает сертификацию отдельных видов товаров, не в состоянии предоставить техническую документацию (чаще всего это происходит, когда товары были импортированы в страну), либо имеющаяся документация не соответствует требованиям законодательства и действующим нормативным актам, необходимую документацию мы сможем разработать для вас самостоятельно!
Отправить заявку на разработку технической документации
Вас может заинтересовать
Техническая документация
Другие услуги
Отзывы
ООО «ИЛОТ»
Уважаемый Андрей Алексеевич
Компания ООО «ИЛОТ» выражает Вам благодарность за профессиональное многолетнее партнерство и помощь в получении для нашей компании разрешительной документации на технические устройства для разных отраслей промышленности.
Благодаря высококвалифицированной работе команды специалистов «Серконс», ряд сложнейших заказов был выполнен в кратчайшие сроки. Особенно хотелось бы отметить менеджеров Мельникова Георгия и Телицыну Евгению за отзывчивость и оперативность.
Все работы были выполнены качественно и в ожидаемые сроки.
Мы получили большое удовольствие от совместной работы и можем рекомендовать вас как надежного профессионального партнера. Надеемся на долгосрочное взаимовыгодное сотрудничество.
Руководитель отдела логистики ВЭД ООО «ИЛОТ», Эстеркин К.В.
ООО «ПСК-Реконструкция»
Благодарственное письмо
ООО «ПСК-Реконструкция» выражает благодарность ООО «Серконс» за плодотворное сотрудничество в рамках проведения негосударственной экспертизы проектной документации на проекты, разработанные нашей организацией.
Работа выполнялась грамотно и профессионально. Благодарим за рекомендации по устранению замечаний в ходе экспертизы.
Мы уверены, что в дальнейшем сумеем сохранить и продолжить наши партнерские отношения. Особенно хочется поблагодарить Родригес Изабель Владиславовну за эффективное ежедневное взаимодействие с нашими сотрудниками.
Генеральный директор
М.А. Ахиллес
ООО «Галактика»
Настоящим выражаем свою благодарность ГК «Серконс», который является нашим основным партнером в сфере сертификации продукции с 2018 года.
В перечень услуг, оказываемых нам ГК «Серконс», входит оформление Сертификатов Соответствия Таможенного Союза и Деклараций Соответствия Таможенного Союза.
Отдельно хочется отметить профессионализм работы менеджеров по сертификации продукции Мельникова Георгия Викторовича и Телицыну Евгению Николаевну – их ответственное отношение к каждому запросу, высокую скорость обработки запросов и оперативное разрешение возникающих вопросов.
Благодарим за сотрудничество и надеемся на эффективное взаимодействие в будущем!
Генеральный директор
И.В. Липский
ООО «МорНефтеГазСтрой»
Уважаемая Яна Александровна!
Компания ООО «МорНефтеГазСтрой» выражает глубокую и искреннею благодарность ООО «СЗРЦ ПБ» за профессиональный подход к своей работе. Квалификация и опыт специалистов, которые всегда на связи, позволили оперативно решить возникшие вопросы в кратчайшие сроки и выполнить работу в соответствии со всеми нормами и правилами.
Желаем процветания и финансового благополучия вашей компании. Будем рассчитывать на дальнейшее плодотворное сотрудничество в сфере проведения испытаний по определению пожаробезопасности продукции и сертификации.
Генеральный директор
Тижук М.М.
ООО «ВолгоградНИПИморнефть»
Уважаемый Алексей Петрович,
Выражаем Вам благодарность за качественно выполненную услугу по разработке специальных технических условий на проектирование и строительство объекта в части обеспечения пожарной безопасности блока хранения и налива СУГ по объекту:
«Освоение месторождения D33 с объектами инфраструктуры. Первый этап освоения. Реконструкция трубопровода товарной нефти НСП «Романово» – ООО «ЛУКОЙЛ-КНТ».
Все работы были выполнены качественно и в запланированные сроки.
Особенно хотелось бы отметить менеджера Дарью Олеговну Мастерских и экспертов Митичкина Александра Алексеевича и Черникова Евгения Михайловича за их профессионализм и оперативную работу.
Мы можем рекомендовать ГК «Серконс» как надежного профессионального партнёра и надеемся на дальнейшее взаимовыгодное сотрудничество.
Первый зам. генерального директора – Директор по развитию бизнеса – Главный инженер
А.В. Скурлатов
ООО «Мастер РУФ»
Благодарственное письмо.
От лица компании ООО «Мастер Руф» выражаем вам благодарность за качественно выполненную услугу по проведению негосударственной экспертизы проектной документации на проекты, разработанные нашей организацией.
Все работы выполнены качественно и в ожидаемые сроки. В особенности хотелось бы отметить менеджера Родригес Изабель Владиславовну – за профессионализм и оперативную работу.
Мы можем рекомендовать ООО «Серконс» как надежного и профессионального партнера, и надеемся на дальнейшее взаимовыгодное сотрудничество.
С уважением,
Генеральный директор
И.Н. Малахов
Золотой медвежонок 2020
Благодарность
Оргкомитет
XI Национальной премии в сфере товаров и услуг для детей «Золотой медвежонок – 2020» выражает глубокую признательность за экспертную поддержку и профессиональный подход к работе в Экспертном совете Техническому директору испытательного центра ГК «Серконс» Прокопьевой Ирине Александровне.
Ваш экспертный опыт – ценный вклад в развитие премии.
С нетерпением ждём Вашего участия в XII национальной премии «Золотой Медвежонок – 2021».
Председатель оргкомитета
А.В. Цицулина
ООО «Газэнергосеть розница»
Благодарственное письмо
Уважаемый Алексей Петрович!
ООО «ГЭС розница» выражает благодарность ГК «Серконс» за выполненную работу по проведению специальной оценки условий труда (СОУТ) в нашей компании в 2020 году.
Благодаря компетентности и высокому уровню профессионализма специалистов ГК «Серконс» услуги по проведению СОУТ были выполнены качественно и своевременно.
Коллектив ООО «ГЭС розница» желает Вашей команде успехов во всех начинаниях и достижения всех поставленных целей. Надеемся в будущем на взаимовыгодное сотрудничество с Вашей организацией!
С уважением,
Заместитель генерального директора –
Главный инженер ООО «ГЭС розница»
С.А. Карабашев
ФКП «Анозис»
Уважаемый Алексей Петрович!
ФКП «Анозит» выражает благодарность экспертной организации ГК «Серконс» за качественно проведенное техническое диагностирование и экспертизу промышленной безопасности на производственных площадках нашего предприятия.
Хотим выразить благодарность за высокую организованность сотрудников и способность быстро и качественно решать поставленные задачи.
Особенно хотим поблагодарить специалиста по промышленной безопасности Баздрова Олега Андреевича, инженеров Фёдорова Алексея Владимировича и Безуглова Антона Юрьевича, а также руководителя отдела лицензирования и регистрации ОПО – Юзвенко Романа Евгеньевича, за корректно выполненную работу и ответственный подход к выполнению поставленных задач.
Главный инженер
О.Г. Бенцлер
АО «Раменский приборостроительный завод»
Уважаемый Алексей Петрович!
АО «Раменский приборостроительный завод» выражает благодарность и признательность лично Вам и всему коллективу ГК «Серконс» за оперативное и качественное проведение специальной оценки условий труда на нашем предприятии.
На всех этапах сотрудники демонстрировали профессиональный подход к делу и высокую квалификацию в области проведения СОУТ. Особую признательность хочется выразить эксперту по СОУТ Ли Татьяне Владимировне за качественное и оперативное выполнение работ по СОУТ, широкий спектр профессиональных знаний и непосредственную вовлеченность в рабочий процесс.
Отдельно хочется поблагодарить менеджера Михайлова Станислава Александровича, который был с нами от этапа заключения договора и на протяжении всего рабочего процесса, за его четкую клиентоориентированность.
За время работы мы убедились, что ГК «Серконс» является надежным партнером. С уверенностью можем сказать, что сделали правильный выбор, приняв решение о сотрудничестве с Вами.
Мы рекомендуем компанию КГ «Серконс» как надежного партнера, работающего на высоком профессиональном уровне.
Главный инженер
С.И. Пономарев
ГБК РО «МШОР №8 им. В.В. Понедельника» Ростов-на-Дону
Уважаемый Андрей Алексеевич!
ГБУ РО «СШОР № 8» пользуется услугами ООО «Серконс» по сертификации спортивных объектов, находящихся в оперативном управлении нашего учреждения с 2016 года.
За это время с помощью команды ООО «Серконс» г. Ростова-на-Дону произведена сертификация, а также продление сроков действия сертификатов на спортивные объекты в г. Ростове-на-Дону:
Дворец спорта, открытый футбольный стадион на 1500 зрительских мест, водно-спортивная база «Зелёный остров».
Выражаем благодарность команде менеджеров Вашей компании, при этом особо хочется отметить работу менеджера Сундуковой Нилы Геннадьевны, которая за все эти годы персональной работы с нашим учреждением проявила себя как высокопрофессиональный, грамотный, ответственный и внимательный к проблемам клиента специалист.
Мы и дальше надеемся на сотрудничество с ООО «Серконс» и будем рекомендовать всем Вашу компанию как прекрасно организованную и авторитетную организацию.
С уважением,
И.о. директора А.А. Пивоваров
ООО «Хабаровскремпроект»
Уважаемая Яна Александровна!
ООО «ХАБАРОВСКРЕМПРОЕКТ» выражает благодарность компании ООО «СЗРЦ ПБ» за качественно выполненную услугу по разработке и согласованию специальных технических условий в МЧС России ив Министерстве строительства и жилищного-коммунального хозяйства Российской Федерации.
Так же хотим особо отметить менеджера Синявского Дмитрия Юрьевича и руководителя Отдела независимой оценки риска и экспертизы пожарной безопасности Рементова Андрея Николаевича за профессионализм и качественное исполнение работы.
Мы можем рекомендовать компанию ООО «СЗРЦ ПБ», как хорошо организованную, профессиональную команду, и рады, что приняли решение о сотрудничестве с Вами.
Также на сегодняшний день прорабатываем возможность сотрудничества с Вашей компанией на разработку и прохождение СТУ по планируемому проекту Гостиничный комплекс по пер. Некрасовский 30 в г. Владивостоке.
Генеральный директор
ООО «Хабаровскремпроект» А.А. Радыгин
АО «Евраз НТМК»
Уважаемая Яна Александровна!
АО «Евраз НТМК» выражает благодарность компании ООО «СЗРЦ ПБ» за качественно выполняемые услуги по разработке специальных технических условий.
Мы можем рекомендовать компанию ООО «СЗРЦ ПБ», как хорошо организованную профессиональную команду, выражаем уверенность в сохранении сложившихся отношений и надеемся на дальнейшее плодотворное сотрудничество.
Начальник УКС И.Е. Хаятов
ООО «АББ»
Уважаемый Андрей Алексеевич!
Благодарим ООО «Серконс» в лице Увайской Людмилы Леонидовны и ее команды специалистов за организацию и проведение работ по сертификации, а также декларированию соответствия большого перечня продукции ООО «АББ», подпадающей под действие Технических регламентов Таможенного союза ТР ТС 004/2011 «О безопасности низковольтного оборудования» и ТР ТС 020 «Электромагнитная совместимость технических средств», а также за содействие по другим направлениям нашего сотрудничества с ООО «Серконс», которое длится с 2011 года.
Работа Ваших Специалистов важна и способствует процессу своевременного выпуска продукции ООО «АББ» в обращение на территории Таможенного союза.
Рассчитываем на продолжение стабильного, долгосрочного сотрудничества с ООО «Серконс».
Старший инженер по технической поддержке и сертификации продукции Е.Н. Герасимович
ООО «Магистраль»
Уважаемый Алексей Петрович!
ООО «Магистраль» выражает благодарность ГК «Серконс» за профессиональное оказание услуги по негосударственной экспертизе проектной документации и результатов инженерных изысканий.
За время нашего сотрудничества хотелось бы отметить компетентность менеджера Шуракова Сергея Сергеевича и его способность качественно и быстро решать вопросы.
Нам доставило большое удовольствие сотрудничество с ГК «Серконс».
Мы рекомендуем данную компанию в качестве профессионального партнера и надеемся на дальнейшее сотрудничество.
Генеральный директор ООО «Магистраль» Г.М. Макаршин.
ООО «Старт-Строй»
Генеральному директору ООО «Серконс» Григорьеву А.А.
ООО «Старт-Строй» выражает слова искренней благодарности руководству и сотрудникам ООО «Серконс» за проведение экспертизы проектной документации строительства объекта: «Многоквартирный жилой дом №4 по адресу: г. Н. Новгород, Советский район, у дер. Кузнечиха».
Отмечаем высокий профессионализм сотрудников Вашей организации, высокое качество работы. Благодаря слаженным действиям команды экспертов и менеджеров сопровождения, экспертиза была проведена в кратчайшие сроки и на высоком профессиональном уровне.
Желаем Вам профессионального роста и успехов в бизнесе.
Генеральный директор Поваляев А.В.
ГРУППА КОМПАНИЙ «ИСТА»
Благодарственное письмо
Компания ООО «ИСТА-Техника» благодарит коллектив филиала органа по сертификации «СЕРКОНС» в г. Санкт-Петербург за эффективную работу специалистов, оперативность выполнения работ по обязательной сертификации и декларированиюпродукции и внимательное отношение к Заказчику.
Квалифицированные менеджеры и их ассистенты — Лукконен Александра Владимировна, Васильевская Дарья Алексеевна, Савченко Анастасия Николаевна, а также экспертный состав испытательных лабораторий «СЗРЦ ПБ» и «НОРМАТЕСТ», продемонстрировали глубокое знание специфики продукции в области пожарной безопасности.
Компания ООО «ИСТА-Техника» характеризует филиал органа по сертификации «СЕРКОНС» в г. Санкт-Петербург как профессионального и надежного партнера в области обязательного подтверждения соответствия продукции требованиям технического регламента Евразийского экономического союза «О требованиях к cредствам обеспечения пожарной безопасности и пожаротушения» ТР ЕАЭС 043/2017.
С уважением,
Директор центра пожарной безопасности,
Павлов А.П.
Смотреть все