В заметке ТЗ для web-разработчика автор пишет:

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

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



Вступление


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

Задача определяет выбор инструмента


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

Макеты


Макеты предоставляют
  1. Наглядность
  2. Однозначность расположения элементов
  3. Лаконичность

Макеты не предоставляют
  1. Информации о функционировании элементов
  2. Формализации


Текстовые описания


Текстовые описания предоставляют
  1. Полную информацию о функционировании
  2. Полное описание свойств блоков, элементов и т.д.
  3. Формальность описания

Текстовые описания не предоставляют
  1. Наглядность


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

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


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

Каждому своё


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

Примеры неправильного применения


Описание расположения при помощи текста

Пример приведён в заметке «ТЗ для web-разработчика»:
Сверху должен распологаться логотип, правее форма для авторизации пользователей, чуть ниже логотипа — ссылки сайта, под ссылками — топ комментируемых новостей, и еще ниже блок рекламы. По центру должна находиться форма поиска, под ней — последние добавленные объявления, затем блок рекламы, и последние новости. Под формой авторизации должен распологаться блок с последними комментариями на форуме, и ниже блок рекламы. В самом низу страницы будут находиться счетчики-пузомерки, а так же копирайты

Я согласен с автором — здесь явно уместнее будет макет.

Описание свойств при помощи макета

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

Почему здесь должно быть текстовое описание?
  1. Не все свойства товара могут отображаться в «карточке»
  2. Не всегда можно однозначно понять из макета тип свойств. Пример — цена может быть числом, а может строкой, текст может быть коротким или очень даже длинным, картинок может быть ограниченное количество, а может и нет.
  3. На макете за свойства товара могут быть приняты свойства других объектов (напр. категории) или вычисляемые свойства

Выводы


Общие
  • «Самых правильных» способов подачи информации не существует!
  • Подходящий способ подачи определяется:
    • Характером информации
    • Задачей (адресатом)

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

Применительно к ТЗ (моё личное мнение)
  • ТЗ — это технический (а часто и юридический, напр. приложение к договору) документ и большая его часть должна быть представлена в текстовой форме.
  • Макеты должны быть приложением к ТЗ, призванным увеличивать доступность текстовой информации, но не заменять её.
  • Кроме «чистого» текста и макетов есть ещё таблицы и списки, которые могут увеличить наглядность, лаконичность и доступность информации. Иногда они могут успешно заменить макеты. Используйте их чаще!

Ссылки по теме