Методические указания по подготовке и защите отчетов на специализации "Прикладная математика. Системное программирование". Кленин А.С. - 14 стр.

     Раздел состоит из подразделов, по одному на каждый описываемый объект. Названия
подразделов должны начинаться со слов «Протокол», «Формат», «Сущность» и т. п., за
которыми следует название соответствующего объекта данных. Если объекты могут быть
содержательно сгруппированы по подсистемам, выделенным в п. 3 (например, сущности,
хранимые в БД каждой подсистемой), и таких объектов в среднем не менее трёх в каждой
группе, то следует ввести подразделы третьего уровня.

     Раздел «4.1. Описание формата или структуры данных»
     Описать назначение формата, указать предполагаемый носитель (например, файл или
оперативная память).
     Указать, текстовый или двоичный формат. Для текстового формата указать: коди-
ровку символов, правила использования символов перевода строки и возврата каретки
(CR/LF), возможно, базовый формат (например, XML). Для двоичного формата указать
способ кодировки многобайтных целых чисел (big- или little-endian), формат веществен-
ных чисел (например, IEEE-754 Single Precision).
     Подробно описать синтаксис и семантику каждого элемента данных, привести при-
меры. Если возможно, привести таблицу полей или другое структурированное изображе-
ние формата. Описать возможные ошибки в представлении данных и реакцию на них.

     Раздел «4.2. Описание сущности»
      Термин сущность (таблица) обычно используется при разработке баз данных и объ-
ектно-ориентированных систем.
      Описать назначение сущности («предназначена для хранения …» либо «реализует
понятие …»).
      Перечислить атрибуты сущности, имеющие смысл в предметной области. При этом
не указываются служебные поля БД, невидимые для пользователя (например, искусствен-
ный первичный ключ, время последней модификации или номер реплики). Для каждого
атрибута указать:
      • полное название по-русски (а не имя соответствующего поля БД),
      • тип (без детализации, например, не «VARCHAR(200)», а «Строка»),
      • ограничения на допустимые значения,
      • обязательность,
      • доступность для редактирования,
      • уникальность (для составных ключей указать «комбинация значений атрибутов
          A, B, … должна быть уникальной»),
      • значение по умолчанию (если есть).
      Если атрибут используется для создания отношения «один ко многим», следует ука-
зать его тип как «ссылка на Название сущности», а не «Целое число».
      Оформить список атрибутов в виде таблицы, содержащей все или часть из перечис-
ленных характеристик. Часто повторяющиеся значения вынести в текст после таблицы.
Например «Значения атрибута Фамилия должно быть уникальным» или «Для редактиро-
вания доступны все атрибуты, кроме атрибута Дата создания объекта».
      Описать дополнительные требования к данным сущности. Перечислить объекты
сущности, автоматически создаваемые при установке системы, и значения их атрибутов.
      Привести диаграмму классов (или объектов).




                                            14