Шаблон техзадания на разработку плагина
Описание плагина, его назначение. Краткое описание плагина.
2. Постановка бизнес задачи# Входные данные#Внешние (относительно Revit) данные и их формат для использования плагином в работе.
Какие данные могут быть введены пользователем во время работы плагина.
Элементы Revit, которые плагин должен считывать и использовать в алгоритме работы.
Для исходных данных из Revit могут быть указаны
категории элементов
группы элементов
свойства элементов, для которых поставлены условия соответствия
В качестве внешних данных можно не описывать подробно формат, а добавить в приложение к ТЗ файлы. Например для обработчика коллизий можно добавить файлы отчётов в разных форматах с разным содержимым.
Выходные данные#какие будут созданы новые элементы или удалены имеющиеся
какие свойства будут изменены у исходных элементов
какие данные и в каком формате будут экспортированы плагином во внешнюю среду
Если плагин осуществляет трансфер каких либо данных из одного файла ревит в другой, то об этом нужно написать здесь. Формат данных разработчики формируют на своё усмотрение.
Что должен делать плагин#Случаи использования плагина. Должно быть написано, как в описании, кратко для каждого конкретного случая, что необходимо проектировщику.
Описание последовательности сбора информации, расчётов и записи результатов в дополнение к user case-ам. Алгоритм, описаный некой последовательностью действий. Наприммер:
Пользователь открывает плагин, выбирает формы в проекте
Плагин для каждого элемента находит геометрическую принадлежность к одной из выбранных форм
Каждому элементу записвается свойство с определенным именем, туда записывается название формы
Плагин показывает отчет об успешных и несостоявшихся операциях
Эскизы макета UI для каждого шага пользовательского ввода данных и информирования пользователя о совершаемых действиях. Последовательность шагов, и элементы UI, которые обеспечивают переключение по этой последовательности.
Требования к стилю интерфейса. К его отзывчивости, простоте, компактности и скорости.