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

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

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

Если для полного понимания документа обязательно требуется однозначное понимание слов или требуется рассказать о контексте/предмете, то, без сомнения, необходимо создавать раздел «терминология» или «описание предметной области».

Терминология

Раздел «терминология» прост, в нем приводятся пояснения используемых в документе слов, как это делается в толковом словаре. Единственное, что нужно помнить — нельзя давать определение неизвестного читателю слова, используя другие неизвестные читателю слова.

Ярким примером может стать определение:

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

Предметная область

В разделе «Описание предметной области», необходимо подробно описать всё что нужно читателю, прежде чем переходить к изложению основной части документа. Например, прежде чем предлагать инвестору бизнес-проект (основная часть), нужно описать сложившуюся ситуацию (предметная область).

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

Пример с диаграммой

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

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

Заказчик

Экземпляр

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

Подобным образом описываются все сущности диаграммы.

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