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

Инспектор: Антон Тидор

 I. Архитектура системы:
	    
    1.1 Файлы используемые при работе: 
 	- П3- Индексный файл: Два разных определения индексного Файла. Первое опр. слово "каждый" - не понятно к чему относится
	- База дынных: Что представляет собой элемент базы данных; "В первичной индексной базе это вся запись" - 
          слово "запись" требует пояснения.
        - "Вторичные - в качестве ключа используется одно поле - некоторое подмножество записи" - "нек. подмн. записи" - некорректная формулировка
        - П4 "Хранилище потоков - Набор потоков" - информация! о потоках хранится в файлах

    2. Описание форматов файлов: 
      2.1 Шаблон
	- Файл шаблона содержит описание внутреннего представления .... внутри фильтра и ... - тавтология!
	- Формат: "[признак индексируемости]" - некорректное словосочетание
      2.2 Файл условий
	- "По умолчанию файл ... в тек. каталоге" - не ясно, что по умолчанию файл или каталог. Имя файла можно менять?
	- Формат файла: опечатка - "звание"... 
	- <Тип поиcка> - в обоих случаях не определено, какое действие будет совершатся "По точному значению..."/ "По нижней и верхней гр. ..."

 II. Архитектура функций модулей: 

    Описание архитектуры функций индексатора: 

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

      6.1 Интерфейсная часть: 
	- "Тело данной функции находится в отдельном файле" - немного некорректное использование слова "тело"
/??	- 6.1.1 Описание функции: Получаемые параметры "количество слов...", "массив содержащий указанные слова" - необходимо пояснить значения слов "слова" (напр. набор символов разделённые пробелом) ??/
	- 6.1.2-е) "Остаток командной строки..." - употребление слова "остаток" некорректно в данном контексте
	- Схема работы функции: "При ошибочном значении #(вызываемой функции)# программа завершает работу" - не понятно какое значение считать ошибочным
	- Функция индексирования. Описание функции: "массив строк, содержащих имена файлов, содержащих записи..." - повтор!
	- Схема работы функции: "При ошибочном значении #(вызываемой функции)# программа завершает работу" - не понятно какое значение считать ошибочным

   Описание архитектуры функций перенесённых из flow-tools:
      1.
	- Описание функции: Получаемые параметры "в качестве этих данных передается структура..." - не понятно какие данные в каком виде (пояснить),
	  "... В точности скопирована" - не подходящее словосочетание
	- Схема работы функции: 2 - не ясно откуда получается "возвращаемое значение",
          2-b Не понятно что подразумевается под словами "конвертирование записи" и  "сохранение ее в блок"
      2.
	- Схема работы функции: 1 - "В случае ошибки - возвращение значения..." - действие не понятно (какое значение и когда?),
	  В каждом пункте по разному описаны схожие действия.
      3.
	- ?
	
      4.
	- Схема работы функции: 2п. "Определение соотв. смещения..." - фраза в целом сложна для понимания.
      5.
	- 

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

      7.1 Интерфейсная часть:
 	- "Тело данной функции находится в отдельном файле" - немного некорректное использование слова "тело"
	- 7.1.1 Описание функции: Получаемые параметры "количество слов...", "массив содержащий указанные слова" - необходимо пояснить значения слов "слова" (напр. набор символов разделённые пробелом) ??/
	- 7.1.2-е) "Остаток командной строки..." - употребление слова "остаток" некорректно в данном контексте
	- Описание работы оператора switch ("иные действия программы") - перед пунктом с) и d) не хватает символа переноса строки
	- Схема работы функции: "При ошибочном значении #(вызываемой функции)# программа завершает работу" - не понятно какое значение считать ошибочным
     7.3 Чтение файла условий
	- 7.3.2 Схема работы функции: 2 пункт: "В цикле производится построчное чтение !файла шаблона!" "При чтении одной строки !файла условий!" - 	
                предложения противоречат друг другу.	
     7.4 Функция фильтрации
	7.4.1 Описание функции. Получаемые параметры: "файловый дескриптор, в который будет осуществляться вывод..." - вывод производится в файл
 	        


  Общие функции
	Функция чтения шаблона: "Тело данной функции находится в отдельном файле" - немного некорректное использование слова "тело"
 	- возвращает ... число, определяемое следующими определёнными..." - повтор!
	- 8.1.2 Схема работы п3-с: "Заполненная структура ... добавляется ! к ! массиву" - предлог "к" не соответствует данному контексту