RU

Техническое задание на приложение: что такое спецификация и зачем её утверждать

Спецификация на одну страницу, которую вы сначала утверждаете: обложка статьи в блоге Deployflix

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

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

Что такое спецификация программы простыми словами?

В разработке программ спецификация (в крупных проектах её часто называют техническим заданием или SRS — software requirements specification, спецификацией требований к ПО) — это договорённость между тем, кому нужно приложение, и тем, кто его создаёт. Она говорит, что должно делать приложение, а не как это делает код. Для магазина, клуба или школы обычно хватает одной страницы, если она конкретна и написана простыми словами.

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

Что входит в техническое задание на приложение на одну страницу?

Возьмём репетиторский центр, которому нужно приложение для занятий, посещаемости и оплаты. Полезная спецификация на одну страницу для него состоит из таких частей:

Часть спецификацииЧто в ней сказаноПример для репетиторского центра
Кто пользуетсяКаждый тип людей, которые входят в приложение, и что им разрешено делатьВладелец, репетиторы, ученики и родители; только владелец видит итоговые суммы оплат
Экраны по ролямСтраницы, которые видит каждая роль, и что там делаютРепетитор: занятия на сегодня, отметка посещаемости, ввод оценок за тесты. Родитель: посещаемость, оценки, предстоящие платежи
Хранимые данныеЗаписи, которые хранит приложение, и что содержит каждаяУченики, занятия, посещаемость каждого урока, тесты и оценки, взносы за обучение и квитанции
ИнтеграцииВнешние сервисы, к которым оно подключается, и какОнлайн-оплата обучения через платёжный шлюз с квитанцией за каждый взнос
Пока не входитЧего эта версия делать не будетБез проверки накладок в расписании; без импорта записей прошлого года
Предел стоимостиМаксимальная стоимость сборкиМаксимум, показанный до утверждения, а не оценка после работы

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

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

Когда вы описываете приложение в Deployflix, спецификация, которую он пишет, строится так же: кто пользуется приложением, его экраны, хранимые данные, что пока не входит и максимальная стоимость сборки — на том языке, на котором вы писали. Если что-то в описании неясно, он спросит, прежде чем составлять план. На странице как это работает показано, где спецификация находится среди шагов.

Как читать спецификацию приложения и задавать ей вопросы?

Не читайте спецификацию как договор, сверху вниз. Читайте её как день из жизни вашего бизнеса.

  1. Пройдите реальный день за каждую роль. Что человек нажимает, что видит, что вводит? Затем сделайте то же для каждой другой роли.
  2. Проследите одну запись от начала до конца. Выберите одного ученика, заказ или бронирование. Кто её создаёт, кто меняет, кто может удалить и где она оказывается в итоге?
  3. Ищите неприятные сценарии. Отменённая запись, возврат денег, ошибочный ввод, неудачный платёж, ушедший участник. Если в спецификации описано только то, как всё идёт хорошо, спросите, что будет, когда что-то пойдёт не так.
  4. Проверьте каждое число и слово, которое вы будете печатать. Форматы счетов, взносы за обучение, налоговые строки и номера квитанций должны соответствовать тому, как вы работаете сегодня. Если в ваших счетах должен быть указан налог, например GST, НДС или налог с продаж, уточните детали у бухгалтера.
  5. Спрашивайте обо всём расплывчатом. Слова вроде управлять, отслеживать, легко и отчёты скрывают решения. Спросите: какой отчёт, что в нём, для кого?

Какие пробелы искать перед утверждением?

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

Кто что видит

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

Правка, отмена и откат

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

Деньги

Если приложение принимает платежи, в спецификации должны быть описаны этапы оплаты: какими способами могут платить клиенты (карты и местные способы оплаты), за что они платят, разрешена ли частичная оплата, что клиент получает после платежа и что происходит, если платёж не внесён или не прошёл. Правила возврата определяет бизнес, поэтому запишите свои. Обычно шлюзы берут процент от каждой операции, а во многих странах ещё и фиксированную комиссию, поэтому проверьте страницу тарифов вашего шлюза. Приложения Deployflix принимают платежи через платёжные шлюзы, например Razorpay или Cashfree; международные шлюзы появятся скоро. На нашей странице интеграций указано, что можно подключить уже сейчас.

Сообщения и напоминания

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

Ваши существующие данные

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

Устройства и языки

Люди будут пользоваться приложением на телефоне, компьютере у прилавка или на обоих устройствах? Нужно ли, чтобы оно было не только на английском, но и на испанском, арабском, французском или другом языке? От этого зависит устройство экранов, поэтому решите всё до начала создания. Deployflix пишет тексты приложения на выбранном вами языке, а сам работает на 41 языке.

Зачем утверждать спецификацию до начала сборки?

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

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

Спецификация также определяет стоимость до того, как вы примете решение. Когда в ней указана максимальная стоимость сборки, вы решаете, зная конкретную сумму. В Deployflix этот предел показан до утверждения, а платите вы только за ресурсы, фактически использованные при сборке. Подробнее об этом — на странице цен.

Как планируются изменения после создания приложения?

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

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

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

Шаблон спецификации приложения, которым можно пользоваться

Если вы пишете спецификацию сами, скопируйте эти заголовки и заполните каждый простыми предложениями:

  • Приложение в одном предложении: для кого оно и какую задачу решает.
  • Роли: каждый тип пользователей и что им разрешено видеть и делать.
  • Экраны по ролям: для каждой роли — экраны и что происходит на каждом.
  • Хранимые данные: каждый вид записей и что в нём содержится.
  • Интеграции: платежи, ваш домен, магазины приложений, где хранится код и всё остальное, к чему оно подключается.
  • Правила: оплаты, ограничения, сроки, отмены и возвраты.
  • Пока не входит: чего эта версия делать не будет.
  • Предел стоимости и утверждение: максимальная стоимость и кто даёт согласие.

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

Вопросы

Чем спецификация приложения отличается от технического задания?

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

Кто должен писать спецификацию приложения?

Содержание даёт тот, кто знает бизнес: роли, повседневную работу и правила. Исполнитель может превратить это в структурированную спецификацию, но только вы можете сказать, правильна ли она.

Можно ли изменить спецификацию после утверждения?

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

Какой длины должна быть спецификация приложения?

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

Опишите своё приложение

Опишите своими словами, что вам нужно. Deployflix напишет план на одну страницу со стоимостью и начнёт сборку только после вашего утверждения.