Проверка содержания документов

Проверка содержания документов

Проверка содержания разделов документов производится для выявления возможности улучшения восприятия текста документа, его «читабельности». «Читабельность» текста документа прямо зависит от соответствия содержания раздела (подраздела и т.д.) его названию. Так, к примеру, если раздел называется «Назначение программы», то в тексте раздела должна быть размещена информация ТОЛЬКО о назначении программы. И никакая иная - любая посторонняя информация будет воспринята читающим как информационный шум.

Большое значение имеет также стиль изложения текста. Пример «правильного» стиля изложения приведен на рисунке (ниже).

В приведенном примере содержание подраздела 2.1 полностью соответствует его названию и не содержит информационного шума. Текст состоит из вводной фразы «ГИС ...предназначена для решения перечисленных ниже задач» и перечисления самих задач. Многие пишут «следующих задач», но это не совсем точно, поскольку задачи никуда не следуют, а всего лишь перечислены ниже... Документ, построенный по данной схеме, «прозрачен» в смысле поиска информации и безупречен в плане «понятности». Его не придется читать с карандашом в руке, выискивать и подчеркивать «основные мысли», как ранее многим приходилось поступать при изучении классиков марксизма-ленинизма.

Проверка содержания разделов документов также проводится на предмет соответствия ГОСТ 2.105 в части разметки и стиля изложения текста документа: исключаются обороты разговорной речи (включая обращение «на вы»), техницизмы, профессионализмы, синонимы (единство терминологии) и т.д., проверяется соответствие физических величин ГОСТ 8.417 и прочее.

Для формальной оценки качества документации при подведении итогов конкурсов очень удобен ГОСТ 28195-89 Оценка качества программных средств. Общие положения. Из двухсот с лишним метрик, применяемых при экспертной оценке, свыше сотни имеет непосредственное отношение к программной документации. Поскольку программная документация по своим формальным признакам мало чем отличается от документации, к примеру, на автоматизированную систему, то простым «подсчетом голосов» - нулей и единиц по каждой метрике - однозначно выявляется документ-«победитель». С практической стороной оценки качества техдокументации можно ознакомиться в цикле статей «Качество технической документации».

Нередко в документах, в различных их частях (а то и на одной странице), применяются синонимы, такие как «журнал событий», «файл формата log», «log-файл», «лог» и им подобные (по ГОСТ - контрольный журнал). Несмотря на то, что смысл этих понятий един и ясен, документ выглядит выполненным небрежно, на скорую руку, без должного уважения к тому, кто будет его читать. В подобных случаях (если отсутствует ГОСТированное определение понятия) следует подготовить специальный раздел, содержащий нестандартные термины и их определения, и исключить синонимы в тексте.