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

Основные типы документации, которую мы пишем:

  • техническое задание;
  • пользовательские инструкции;
  • документация на проект.

Основные этапы создания документации

  1. собираем и анализируем информацию о текущем сайте и планируемых изменениях, изучаем код, проводим интервью с заказчиком;
  2. проектируем структуру документа — разбиваем его на разделы и подразделы, что позволяет сделать работу над ним максимально системной;
  3. пишем документацию в каждом из разделов, основная задача при этом — найти и решить все противоречия между отдельными требованиями;
  4. сдаем документацию клиенту и вносим правки, если мы что-то упустили.

Почему мы?

  • регулярно пишем документацию на сложные веб-сервисы — и нам это нравится;
  • используем собственную методику написания ТЗ на основе ГОСТ 34.602-89 — у разработчиков при работе с этим стандартом возникает минимум вопросов;
  • используем вайрфреймы (блочные прототипы) для описания интерфейсов, что позволяет еще до стадии дизайна понять как должен работать тот или иной интерфейс.

Вопросы и ответы

1. Можно ли заказать только написание ТЗ, если разработчики у нас свои?
Да, мы можем создать качественную документацию для любых разработчиков или веб-студий. Конфликта интересов тут не возникает, совместная работа с коллегами по цеху для нас является нормальной практикой.

2. Нам нужно начать разработку, то есть только общее понимание конечного результата. Что делать?
Довольно распространенная ситуация. Мы в таком случае рекомендуем сократить ТЗ до MVP (минимального работоспособного продукта) — т.е. первым этапом внедрить самый основной функционал, который понятен изначально, а затем проверять получившийся продукт в деле и дорабатывать отдельные его функции. Таким образом вы гарантированно получите путь не идеальный поначалу, но реально работающий продукт.

Возврат к списку услуг