Составить тз: Как составить техническое задание и получить то, что нужно

Posted:

Дек 7, 2022

Comments:

Составить тз: Как составить техническое задание и получить то, что нужно — СКБ Контур

Содержание

как составить ТЗ, чтобы разработчики вас поняли — KozhinDev на vc.ru

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

414
просмотров

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

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

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

Кто составляет ТЗ

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

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

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

Этапы создания ТЗ

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

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

Слабые места ТЗ

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

Субъективные оценочные суждения

Избегайте слов «красиво», «быстро», «просто» и других подобных оценок — они не несут в себе конкретного смысла и могут быть поняты множеством разных способов. Замените их конкретикой:

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

Не бойтесь написать больше: в техническом задании это может принести пользу.

Непонятные термины

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

Чрезмерная или недостаточная детализация

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

Подведем итоги

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

однозначным;
объективным;
подробным;
понятным для исполнителя и заказчика.

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

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

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

Что такое ТЗ и как правильно составить техническое задание

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

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

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

Комьюнити теперь в Телеграм

Подпишитесь и будьте в курсе последних IT-новостей

Зачем нужно ТЗ

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

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

Также ТЗ формирует ожидаемый результат и дает возможность оценить результат проделанной работы.

Каким должно быть ТЗ

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

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

Нужно написать небольшой текст на тему «Душевые кабины». Текст должен быть для людей. Без переспама.

А кто-то описывает все в деталях и структурирует каждый аспект:

Нужно написать текст на тему «Душевые кабины» объемом 3500 знаков. Уровень спама – до 55%, уровень воды не более 18%, уникальность – от 90%. Слово «душевые» использовать не более 15 раз. Избегать стоп-слов (и, или, но, а).

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

Технические характеристики

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

В случае с текстами сюда можно отнести:

количество знаков на абзац,

тип и размер шрифта,

количество используемых ключевых слов,

правила структурирования текста с помощью подзаголовков,

необходимые форматы данных (таблицы, списки, цитаты и т. п.).

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

выбор системы управления данными (WordPress, Joomla и т.п.),

выбор фреймворков (React, Angular и т.п.),

количество всплывающих окон,

ширину контентной части страницы,

расположение форм обратной связи в приложении,

дополнительные функции.

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

Маркетинговые характеристики

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

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

Заказчик рассказывает о целевой аудитории и ее особенностях. Задача исполнителя – воспользоваться этой информацией и сделать итоговый проект/текст наиболее привлекательным для указанной ЦА.

Этапы работы

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

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

Демонстрация первого прототипа.

Приемка первой тестовой версии продукта.

Тестирование функциональности.

Разработки дизайна.

А/Б-тестирование визуальных компонентов и CTA-элементов.

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

Другие аспекты

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

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

Срок выполнения работы тоже приписывается заранее, как и общий бюджет проекта.

Примеры ТЗ

Рассмотрим два абстрактных примера технического задания в том виде, в котором они часто встречаются.

Для разработчиков

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

Сайт должен быть выполнен в соответствии с указанным макетом. Цветовая палитра, расположение объектов, шрифты, текст и прочие элементы из Figma должны быть перенесены на итоговый проект.

Текст ТЗ может содержать более конкретную информацию об имеющихся функциях:

На сайте должна быть форма для загрузки файлов (только в форматах JPG, PNG).

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

Если пользователь долго бездействует (более 20 секунд), должен появляться робот-помощник (его функциональность описана ниже).

Под каждым материалом на сайте должна быть секциями с комментариями.

Также в ТЗ можно внести требования к дизайну и оформлению кода:

Цвет подзаголовков берем из макета (#CD6326).

Списки должны быть оформлены в формате ul > li > a.

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

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

Работа должна быть доступна в репозитории my-new-project.

Каждое изменение должно сопровождаться отдельным коммитом.

В качестве базы данных используется технология MongoDB.

Для копирайтеров

Текст на тему «Стоит ли использовать WordPress в 2020 году?».

Общие требования к тексту:

Статья должна быть поделена на части. Каждый подзаголовок отделяет один логический блок.

В тексте необходимо использовать одну таблицу и минимум один список.

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

В тексте должны быть подзаголовки второго уровня, минимальный промежуток между подзаголовками – 750 символов, максимальный – 900 символов.

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

Ключевые фразы должны быть равномерно распределены по тексту. Расстояние между ключевыми фразами не менее 1000 знаков. Первое ключевое слово должно использоваться в первом абзаце.

Объем текста: от 10 000 знаков.

Примерная структура текста:

Что такое WordPress.

Основные преимущества WordPress.

Сравнение WordPress с другими CMS.

Ключевые фразы:

WordPress (8)

Темы для ВордПресс (1)

CMS WordPress (2)

Для разработчиков (1)

Для новичков (2)

Как установить на сайт WordPress (1)

Joomla (2)

Drupal (1)

Вместо заключения

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

Проект

Tor | Настройка службы Onion

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

Шаг 0: Получите рабочий Tor

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

Шаг 1: Настройте работающий веб-сервер

В качестве первого шага вам следует настроить локальный веб-сервер, такой как Nginx, Apache или ваш любимый веб-сервер.
Настройка веб-сервера может быть сложной.
Если вы застряли или хотите сделать больше, найдите друга, который может вам помочь, или присоединитесь к нашему списку рассылки tor-onions, чтобы поговорить с другими операторами.

В качестве примера мы рассмотрим, как настроить onionsite с Nginx и Apache в Debian.
Мы рекомендуем вам установить новый отдельный веб-сервер для вашего Onion-сервиса, поскольку даже если он у вас уже установлен, вы можете использовать его (или захотеть использовать позже) для обычного веб-сайта.

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

Apache

Apache доступен в основном репозитории нескольких дистрибутивов Linux и *BSD.
Чтобы установить пакет apache2 :

$ sudo apt install apache2

Nginx

Nginx доступен в основном репозитории нескольких дистрибутивов Linux и *BSD.
Установить nginx package:

$ sudo apt install nginx

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

После настройки веб-сервера убедитесь, что он работает: откройте браузер и перейдите по адресу http://localhost/.
Затем попробуйте поместить файл в основной каталог html и убедитесь, что он отображается при доступе к сайту.

Шаг 2. Настройка службы Tor Onion

Следующим шагом является открытие файла конфигурации Tor (torrc) и выполнение соответствующих настроек для настройки службы Onion.
В зависимости от вашей операционной системы и настроек ваш файл конфигурации Tor может находиться в другом месте или выглядеть по-разному.

Вам нужно будет добавить следующие две строки в файл torrc :

 HiddenServiceDir /var/lib/tor/my_website/
 Хидденсервицепорт 80 127.0.0.1:80

Строка HiddenServiceDir указывает каталог, который должен содержать информацию и криптографические ключи для вашей службы Onion.
Вы захотите изменить строку HiddenServiceDir , чтобы она указывала на фактический каталог, доступный для чтения/записи пользователем, который будет запускать Tor.

Строка HiddenServicePort указывает виртуальный порт (то есть порт, который будут использовать люди, посещающие ваш Onion-сервис), и в приведенном выше случае говорится, что любой трафик, входящий на порт 80 вашего Onion-сервиса, должен быть перенаправлено на 127.0.0.1:80 (именно здесь прослушивается веб-сервер из шага 1).

Совет: Во избежание утечки Onion-сервиса в локальную сеть рекомендуется запускать Onion-сервисы через сокеты Unix, а не через сокет TCP.
Вам нужно будет добавить следующие две строки в файл torrc :

 HiddenServiceDir /var/lib/tor/my-website/
HiddenServicePort 80 unix:/var/run/tor-my-website.sock

Шаг 3: Перезапустите Tor и убедитесь, что он работает

Теперь сохраните ваш torrc и перезапустите Tor.

$ sudo systemctl перезапустить tor

Если Tor снова запустится, отлично. В противном случае что-то не так. Сначала посмотрите на свои файлы журналов для подсказок.
Он напечатает некоторые предупреждения или сообщения об ошибках. Это должно дать вам представление о том, что пошло не так.
Как правило, в torrc есть опечатки или неправильные права доступа к каталогу (см. запись часто задаваемых вопросов по ведению журнала, если вы не знаете, как включить или найти файл журнала.)

Когда Tor запустится, он автоматически создаст указанный вами HiddenServiceDir (при необходимости).
Убедитесь, что это так.

Шаг 4. Проверка работы службы Onion

Теперь, чтобы получить адрес службы Onion, перейдите в каталог HiddenServiceDir и найдите файл с именем hostname .
Файл hostname в вашем каталоге конфигурации Onion Service содержит имя хоста для вашей новой onion v3 службы.
Остальные файлы — это ваши ключи Onion Service, поэтому крайне важно, чтобы они оставались закрытыми.
Если ваши ключи просочились, другие люди могут выдать себя за ваш Onion-сервис, посчитав его скомпрометированным, бесполезным и опасным для посещения.

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

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

(необязательно) Шаг 5. Запуск нескольких служб Onion

Если вы хотите перенаправить несколько виртуальных портов для одной службы Onion, просто добавьте дополнительные строки HiddenServicePort .
Если вы хотите запустить несколько Onion-сервисов с одного и того же клиента Tor, просто добавьте еще одну строку HiddenServiceDir .
Все следующие строки HiddenServicePort ссылаются на эту строку HiddenServiceDir , пока вы не добавите еще одну строку HiddenServiceDir :

 HiddenServiceDir /var/lib/tor/onion_service/
 Хидденсервицепорт 80 127.0.0.1:80
 HiddenServiceDir /var/lib/tor/other_onion_service/
 Хидденсервицепорт 6667 127.0.0.1:6667
 Хидденсервицепорт 22 127.0.0.1:22

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

 сервер {
        слушать unix:/var/run/tor-my-website.sock;
        имя_сервера <ваш-луковый-адрес>.onion;
        журнал_доступа /var/log/nginx/my-website.log;
        индекс index.html;
        корень /путь/к/htdocs;
}

Или в Apache со службой Tor, прослушивающей порт 80:

 
       Имя_сервера  onion>
       DocumentRoot /путь/к/htdocs
       Журнал ошибок ${APACHE_LOG_DIR}/my-website.log

Шаг 6. Советы по безопасности и другие советы

Версия Onion Services по умолчанию — это версия 3, состоящая из 56 символов.
Службы Onion версии 2 устарели и вскоре будут удалены из сети Tor после выпуска версии 0.4.6.x Tor в июле 2021 года.
Дополнительную информацию см. в сообщении блога о сроках устаревания версии Onion Service.

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

Оперативная безопасность.
Передовой опыт работы с луковыми сервисами от Riseup Collective.
OnionScan — это инструмент для проверки того, не утекает ли ваш onionsite информация, которая может поставить под угрозу вашу анонимность, например IP-адрес вашего сервера.

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

Теперь, когда у вас есть работающий onion-сайт, вы можете захотеть развернуть Onion-Location или использовать такие инструменты, как Docker, Heroku, Terraform, Ansible или Stem, для автоматизации управления вашими Onion-сервисами.
Если у вас есть статический веб-сайт, но вы никогда не устанавливали Nginx или Apache, попробуйте еще один проект — OnionShare, где запуск onionsite будет проще: с графическим интерфейсом и минимальной конфигурацией.

Как настроить Tor Browser

Если вы не знаете, что такое Tor Browser, то прочитайте статью что такое сеть Tor.

Скачать Tor Browser только с официального сайта torproject.org .

Будьте осторожны! Есть сайты, имитирующие сайт Tor Project. Например, сайт torprojectS.org (добавил в конце букву S) пытается установить на ваш компьютер троянца. Не скачивайте Tor Browser на сторонних сайтах.

Кстати, Tor Browser сделан на базе браузера Mozilla Firefox, так как это единственный браузер, способный самостоятельно работать с Socks-соединением без операционной системы.

Загрузите Tor Browser с сайта torproject.org

После установки Tor Browser полностью готов к работе. Ниже скриншот с официального сайта.

Posted:

Comments: