Отчет об инспектировании документации проектирования проекта.

Инспектор: Елена Митрукова

1. Составные части программной системы (глобальная архитектура системы).

Автор: Александр Шериков
Ответственный за исправление: Александр Шериков

Недостатки:

	Название документа на титульном листе! Исправить.
	11) Диаграмма "Взаимодействие частей системы" - уместно ли слово "статистика"?

	1) Часть I - 1) -a)
	Что значит "Установление меток", "внутренее представление записи"?
	2) Часть I - 1) -b) переформулировать
	3) c) - "определение внутренних деревьев"?
			------------	
	Что значит "независит от формата данных в хранилище"? От формата данных как раз зависит.
	4) 2) - как файл условий зависит от шаблона и что в нем определяется (1 предложение).
	5) 3) - Непонятное описание индексного файла, в первую очередь это индекс (описать кратко его структуру?),
	каким шаблоном описаны записи? где шаблон хранится и где индексный файл? 
	6) 4) - чем собираются и записываются файлы NetFlow? переформулировать
	7) Часть II - I - "добавить в инд. файл"?  - инд. файл создается за 1 раз?
	Метка? - если это официальное название названия поля, то добавить его в глоссарий?
	8) II ngfilter 
	осуществляет выборку записей из индексного файла по условиям, заданным в файле условий для полей, описанных в шаблоне -
	"для полей, описанных в шаблоне" - непонятно...
	9) Куда результат выборки? Для этого тоже наверное нужны функции?
	10) Арх. фильтра - Фильтр
	"разбор индекса по условиям"? Исправить опечатки в этом абзаце.


2. Описание форматов файлов.

 2.1. Формат шаблона.
 
Автор: Павел Кириков
Ответственный за исправление: Павел Кириков

Недостатки:
	
	1) Что такое plain-text? Пояснить, убрать или добавить в глоссарий?
	2) "Штамп времени"?

 2.2. Формат файла условий. 

Автор: Елена Митрукова
Ответственный за исправление: Елена Митрукова

Недостатки:
	
	1) Что значит "в текущем каталоге"?
	2) "символ табуляции" -> "табуляция"
	3) Неверно отображается в формате pdf
	4) Добавить, что новое условие начинается с новой строки.

3. Описание интерфейсов утилит.

 3.1. Интерфейс индексатора.
 
Автор: 
Ответственный за исправление: 

Недостатки:
	
	1) Исправить "Строит базу данных с индексными базами данных".
	2) В первом абзаце длинные опции написаны с одним "-".
	 
 3.2. Интерфейс фильтра.
 
Автор: 
Ответственный за исправление: 

Недостатки:
	
	1) Первое предложение: фильтр не толкьо формирует набор записей, но и пишет его куда-то!
	2) Описание опции -d: "куда файлы буду сохранены", они оттуда берутся, а не сохраняются...
	3) Опция -с - не обязательная! Хотя бы потмоу что по умолчанию это ngfilter.conf
	4) Опция -о: может указать, далжен ли существовать этот файл  и что будет если он уже
существует?  и это не обязательная опция, раз уж везде указано.

4. Высокоуровневое опсиание архитектур утилит.

 4.1.