Основатель "Техзадание".

Разработка технической документации в IT-сфере и машиностроении:
- Концепции, прототипы и технические задания (ТЗ) для программ, веб-сервисов и мобильных приложений.
- Спецификации, пояснительные записки к техническим проектам, описание технических решений.
- Руководства по эксплуатации, инструкции, видео-инструкции, справочные порталы.
- Документация по ГОСТ.
- Аудит технической документации.

Авторский надзор и управление проектами разработки программного обеспечения.

Работаем с клиентами по всей России и по всему миру. Возможна встреча в Москве или Санкт-Петербурге.
Контакты

Наибольший вклад в теги

Все теги (8)

Лучшие ответы пользователя

Все ответы (4)
  • Что должно быть в серьезном ТЗ?

    @oganesyankaren
    Технический писатель/аналитик
    У вас отсутствует четкая структура ТЗ. Я предложил бы вам 2 варианта переделывания:

    1) Быстрый. Добавить в начало ТЗ разделы про цель интернет-магазина (зачем он нужен) и задачи, которые предстоит решить для достижения цели. Дальше описать структуру ИМ, далее описать каждую страницу структуры - какой функционал должен быть, как должен работать интерфейс и т.п. После описания страниц разместить прочие, важные в рамках вашего проекта требования: SEO, мультиязычность, перенос данных (если есть), админка, верстка, и т.п.

    2) Менее быстрый. Все тоже самое, что в п.1 +
    добавить раздел с описанием используемых в ИМ сущностей, списков, функциональных возможностей, например:
    -Тип данных "Новость", атрибуты "Заголовок (строка)", "Содержимое (html)";
    -Список "Новости", состоит из новостей (тип данных "Новость"), сортировка по дате по убыванию.

    А в описании страниц сослаться на соответствующие сущности, списки, и функциональные возможности, например:
    Страница "Новости" должна включать в себя одноименный список. Каждый элемент списка должен являться ссылкой на страницу соответствующей новости.

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

    С другой стороны важно отметить, что если ТЗ в текущем виде гарантированно обеспечит одинаковое понимание всеми участниками проекта, и учитывает все необходимые моменты, то оставляйте в таком виде, зачем вам делать лишнюю работу.
    Ответ написан
    Комментировать
  • Как правильно описываются функционал и "сущности" при проектировании?

    @oganesyankaren
    Технический писатель/аналитик
    По опыту: проще - лучше. Если у вас сайт или мобильное приложение, подойдет такой формат:
    1) Структура.
    2) Визуальная составляющая.
    3) Архитектурная составляющая:
    - типы данных;
    - списки;
    - функциональные возможности.

    Пример для веб-сервиса:
    Структура
    -Главная
    -Каналы
    --Страница канала 1
    --Страница канала 2
    -О сервисе
    ...

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

    Архитектурная составляющая
    -Типы данных
    --Новость
    ---Тип данных предназначен для учета новостей. Тип данных должен включать в себя следующие атрибуты:
    ----Заголовок* (тип: строка);
    .....

    -Списки
    --Последние новости
    ---Список последних 5 новостей (ссылка на тип данных "Новость"). Список должен включать в себя:
    ----заголовок;
    ....
    ---Список должен быть отсортирован по дате, по убыванию.

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

    ====

    И еще. Если ваш проект реализовывается на готовой платформе, например какой-нибудь CMS, BI-решении или учетной системе, рекомендую обратиться к соответствующим консультантам или самостоятельно изучить возможности и ограничения выбранной платформы. Иначе можете потратить время на описание того, что нельзя будет реализовать из-за технических ограничений.
    Ответ написан
    Комментировать
  • Какие стандарты на инсталляцию ОС на файл сервер?

    @oganesyankaren
    Технический писатель/аналитик
    Добрый день.
    Вы говорите о разделе "перечень документов, на основании которых создается система, кем и когда утверждены эти документы". Это не обязательно должны быть стандарты.
    На сколько мне известно, стандартов для установки ОС нет. Зато есть официальные инструкции производителя (Microsoft), которые уместно упомянуть. Пример: https://www.microsoft.com/ru-RU/download/details.a...
    Кроме официальных инструкций на процесс установки могут влиять внутренние инструкции и стандарты заказчика. Информацию про них следует уточнить и, если нужно, включить в ТЗ.
    Ответ написан
    Комментировать