Простой пример частного технического задания (ЧТЗ) для 1С-ника

27.10.22

Управление ИТ - Стандарты и документация

В статье расскажем о том, как происходит разработка структуры технического задания. Покажем пример технического задания в 1С.

Частное техническое задание (далее ЧТЗ) – это выделенный блок технического задания (ТЗ), в котором описана определенная часть разработок проекта. Как правило, Частное техническое задание описывает определенную небольшую функциональность и позволяет разделить работу по нескольким разработчикам, так чтобы они не «пересекались» в рамках функциональной области. По сути, ЧТЗ – это и есть ТЗ только на часть системы. Обязательный атрибут технического задания на внедрение системы на крупных проектах.

Зачем писать Частное техническое задание на «маленьких» проектах, где и так все понятно?

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

В данной статье будут описаны самые необходимые аспекты разработки технического задания для 1С, взятые из практики внедрения не только на крупных, но и на небольших проектах. Здесь не будет описания ГОСТ-ов и прочих формальностей. Целью статьи является описание упрощенного формата документирования задания на разработку.

Структура представленного здесь примера технического задания для 1С состоит из следующих разделов:

 

1. Контекст задачи

В данном разделе идет описание в следующей последовательности

         пользовательская история -> проблема или предложение -> ожидаемый результат

 

Этот раздел позволяет разработчику понять суть проблемы и спроектировать техническую часть (если он участвует в разработке структуры технического задания)

Заполняется Аналитиком и/или Заказчиком

 

2. Критерии результата

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

Заполняется Аналитиком и/или Заказчиком

 

3. Техническое описание

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

Можно использовать следующие подразделы:

-        Интерфейс (формы ввода, расположение команд)

-        Добавленные, измененные объекты (архитектура)

-        Контрольные процедуры (проверка введенных пользователем данных)

-        Алгоритмы автоматического заполнения

-        Алгоритмы реагирования на события

-        Алгоритмы реагирования на команды

-        Ролевая модель

-        Формы вывода информации

Заполняется Архитектором или Программистом

 

4. Контактные лица

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

 

5. Трудоемкость

Оценка планируемых трудозатрат на выполнение данного ЧТЗ

Заполняется Архитектором или Программистом

 

6. Чек-лист

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

Заполняется Архитектором или Программистом. По желанию, Аналитиком и Заказчиком     

 

Пример технического задания в 1С

 

Хочется еще раз отметить, что ЧТЗ или ТЗ позволяют не только действовать согласованно всем участникам проекта, но и получить осознанное представление о ходе разработки и критериях успешной сдачи работ. Рассмотрим пример технического задания для 1С.

-----------------------------------------------------------------------------------------------------------------------------

 

ЧТЗ-031

Учет личного автотранспорта

 

Контекст задачи

В организации существует необходимость ведения учета использования личного автотранспорта сотрудников. В данный момент учет ведется в файле «Личный автотранспорт.xls». В этот файл заносятся данные о марке транспортного средства и его госномер. У одного сотрудника может быть несколько единиц транспортных средств. Необходимо реализовать данный учет в информационной базе в карточке физического лица.

 

Критерии результата

  1. В карточке физического лица добавлена возможность ввода данных о работе на личном автотранспорте.
  2. Обеспечена возможность ввода и хранения названия марки автомобиля и госномера для каждой единицы личного транспорта человека.
  3. Можно ввести несколько единиц транспортных средств для одного физического лица.
  4. Данные о личном автотранспорте могут вводить только сотрудники кадровой службы. Сотрудники HR-отдела могут только просматривать эти данные. Для остальных сотрудников эти данные должны быть недоступны.
  5. Данные файла «Личный автотранспорт.xls» перенесены в информационную базу.

 

Техническое описание

 

Интерфейс

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

 

 Данные о личном автомобильном транспорте

    

Добавленные объекты

Регистры сведений:

 

Роли:

 

Измененные объекты

Подсистемы:

 

Автозаполнение:

При добавлении новой записи Личный автотранспорт автоматически устанавливать значение поля «Номер по порядку»

 

Трудоемкость

-        Разработка – 1 ч.

-        Перенос данных – 2 ч.

-        Тестирование – 0,5 ч.

Итого – 3 ч.

 

Чек-лист выполнения

1. Разработать функционал и загрузить результат в хранилище. Обновить тестовую базу из хранилища.

отв. Программист

 

2. Загрузить данные из файла «Личный автотранспорт.xls» в тестовую базу 1С.

отв. Программист

 

3. В тестовой базе: добавить в профиль Кадровой службы роль «Редактирование личный автотранспорт», добавить в профиль HR-отдела роль «Просмотр личный автотранспорт».

отв. Аналитик

 

4. Проверка и тестирование результата в тестовой базе 1С.

отв. Аналитик/Заказчик

 

5. Обновление рабочей базы 1С из хранилища.

отв. Администратор

 

6. Загрузка данных из файла «Личный автотранспорт.xls» в рабочую базу 1С.

отв. Программист

 

7. В рабочей базе: добавить в профиль Кадровой службы роль «Редактирование личный автотранспорт», добавить в профиль HR-отдела роль «Просмотр личный автотранспорт».

отв. Администратор

См. также

Стандарты и документация Бизнес-аналитик Бесплатно (free)

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

24.09.2024    5625    0    chavalah    19    

20

Стандарты и документация Бесплатно (free)

Когда при внедрении систем 1С всплывает слово «ГОСТ» – практически всегда речь идёт о документе «Техническое задание». И у большинства внедренцев падает настроение, как только им говорят, что надо «написать ТЗ по ГОСТу». Но опытные кулинары знают, как готовить это блюдо так, чтобы оно оставило после себя приятное послевкусие, а не горькое разочарование. О собственных рецептах приготовления документации по ГОСТу пойдет речь в статье.

21.08.2024    3908    63    Laya    3    

24

Стандарты и документация Бесплатно (free)

Как гарантировать актуальную документацию и превратить ваши тесты в красивый фильм? Берём тесты, сценарии, Vanessa Automation, перемешиваем, но не встряхиваем – и рецепт готов. Расскажем о том, как добиться простой и невозможной цели – чтобы документация к вашему продукту соответствовала ему.

12.08.2024    8119    0    fenixnow    3    

25

Стандарты и документация Бесплатно (free)

В идеале пользовательскую документацию надо создавать под каждый отдельный проект, менять и актуализировать ее, если в функционале что-то изменилось. Но чаще всего в организациях документацию считают неэффективной, поэтому даже не разрабатывают ее, либо документация имеется, но ее никто не использует, так как она устаревшая. Какие шаги надо предпринять, чтобы заинтересовать пользователей документацией и одновременно снизить нагрузку на консультантов 1С, рассказал руководитель службы технической поддержки в ГК «Доброфлот» Арсен Сазандрашвили.

20.08.2019    13141    0    Arsen1986    7    

55

Работа с требованиями Стандарты и документация 1С:Франчайзи, автоматизация бизнеса Россия Бесплатно (free)

Решил «закинуть» на портал свою статью пяти-шестилетней давности. Статья писалась для внутреннего употребления в нашей компании – обобщил и систематизировал свой опыт. Думаю, кому-то она будет полезной. В процессе подготовки статьи немного отредактировал первоначальный вариант.

26.04.2017    28609    0    Soliton    33    

108

Стандарты и документация Программист Бесплатно (free)

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

09.07.2016    28611    0    kuld    4    

42

Стандарты и документация Бесплатно (free)

Оставим за рамками нашей темы поиск потенциального клиента. Мы его нашли. Вот он - Большой клиент. Чего мы хотим? Хотим заработать. И чтобы этот Большой клиент был у нас не один. А к нам большинство таких клиентов пришли по рекомендации, а для рекомендаций положительных нужно, чтобы Большой клиент был очень доволен сотрудничеством с нами. Но и мы хотели бы быть довольны работой с ним. Вот о том, какими документами мы этого добиваемся, я и попытаюсь рассказать. *** Статья написана на основе доклада, прочитанного на Конференции IE 2013 Revolution (7-8 ноября 2013 года). Также она опубликована в журнале Инфостарта № 3

23.03.2015    22124    0    UR1    5    

61

Работа с требованиями Стандарты и документация Программист Бесплатно (free)

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

24.09.2013    39545    0    Neti    21    

72
Комментарии
Подписаться на ответы Инфостарт бот Сортировка: Древо развёрнутое
Свернуть все
1. Nikola23 706 27.10.22 09:42 Сейчас в теме
В трудоемкости (детали) 3,5 часа.
В трудоемкости (сводно) 3 часа. Округлили?)

Вы не учитываете время написания ЧТЗ в трудоемкости?
Это же тоже работа и время.

Особенно это важно, если ЧТЗ кем-то кто не на окладе, а на сделке. Надо все время учитывать.
a-m-gv; sandr13; evgd02; milov.aleksey; +4 Ответить
2. serg33rus 35 28.10.22 10:27 Сейчас в теме
Как мне кажется раздел Техническое описание можно сформулировать только ПОСЛЕ написания. Потому как всегда существует более одного способа решить вопрос. Всегда существует "туман войны" - что-то упустили, что-то недоговорили, что-то неправильно сформулировали.
И непонятно, что делать если в процессе вылез нюанс, который потребовал изменения в структуре данных, непредусмотренные ТЗ. Что делать в этом случае? Сначала переписать ТЗ? А потом программировать? Увеличение трудоемкости.
Ну и еще момент. Заказчику, в подавляющем большинстве случаев, плевать на структуры. Ему, как уже неоднократно звучало, код вообще не нужен (не интересен). Ему нужен результат. И например моих заказчиков будет трудно заставить подписать ТЗ со структурами данных, Для него это абсолютно непонятная хрень, которую он не будет подписывать. Ну не понимает он, что это.
Т.е. если ТЗ готовится для внутренних нужд, внутри команды - это один случай. И там могут быть и структуры и интерфейсы. Они там даже наверно должны быть. Для координации действий. А вот контексты, критерии уже не так актуальны, поскольку это может быть частью системы и там все это уже прописано. А если ТЗ для заказчика, то структуры лишние. Там как раз более подробно функционал, границы, критерии. Что заказчик в состоянии понять и принять.
sandr13; Gesperid; Batman; Olenevod; Award; Laya; Keath; +7 Ответить
3. Tormal 27.01.23 18:49 Сейчас в теме
Я работаю аналитиком внутри фирмы. И такой вариант ТЗ - удобен.
Заказчик согласовывает верх.
Программист видит и преамбулу и что ему делать.
И все в одном месте, а не куча документов.
Для небольших доработок, то что надо.
Olenevod; +1 Ответить
4. user1985977 05.09.23 08:29 Сейчас в теме
А кто-нибудь пользовался ИИ для написания ЧТЗ?
5. user1998411 06.10.23 13:45 Сейчас в теме
Прекрасная статья. Благодарю!
Оставьте свое сообщение