Описание предметной области

2012, June 13
Станислав
Начало статьи: Как написать документ

Слово общение происходит от слова общество. Когда люди получают удовольствие от одинаковых слов, они организуются в общество. Те, кто использует другие слова или не интересуется их значениями, изгоняются из этого закрытого общества.

Роберт Т. Киосаки

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

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

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

 

Описание предметной области - Примеры

Примеры неудачных определений

Главная ошибка - давать определения неизвестных слов при помощи других неизвестных слов или однокоренных слов.

Итератор - это чистая абстракция, то есть все, что ведет себя как итератор и есть итератор.

Существование - деятельность организма для удовлетворения витальных потребностей.

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

 

Примеры правильных определений

Технико-экономическое обоснование (ТЭО) - документ, который доказывает, что проект технически возможен и экономически выгоден. ТЭО - это документ-идея.

Бизнес-план - документ, который дает подробную информацию о том, кто собирается реализовать бизнес-проект, каким образом, в какие сроки и на каком рынке. Бизнес-план - это документ-реализация.

 

Пример правильных определений без создания специального раздела

Прежде чем начать предлагаю разобраться в понятиях "жизнь" и "существование".

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

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

Обращаю внимание, что для некоторых аудиторий, эти определения могут быть неудачными.

 

Описание предметной области - Пример с диаграммой

Представленное ниже описание предметной области используется при моделировании бизнес-процессов, а также при разработке программного обеспеченья. К сожалению, здесь я не буду объяснять правила построения таких диаграмм (подробнее об этой графической нотации см. UML).

 

Описание предметной области

 

Для лучшего понимания предметной области диаграмма дополняется описанием.

 

Заказчик

Атрибут Тип Описание
Название Строка (30)* Сокращенное наименование заказчика
Юр. название Строка (70)* Юридическое наименование заказчика
Контакты Текст* Контактные лица и контактная информация
Дополнительно Текст Дополнительная информация о заказчике

 

Продукт

Экземпляр

Один и тот же продукт может иметь несколько копий и размещаться на разных площадках (на площадке разработчика, на площадке тестировщика, на демонстрационной площадке и т.д.). Каждая такая копия продукта называется Экземпляром.

Атрибут Тип Описание
Тип Тип Экземпляра* Тип экземпляра (см. ниже)
Размещение Строка (100)* URL экземпляра
Дополнительно Текст Дополнительная информация

Рекомендовать "Описание предметной области"