Проверка содержимого разделов документов

Проверка содержимого разделов документов проводится для выявления читаемости текста документа, а также возможностей улучшения его восприятия. Читаемость текста документа прямо зависит от соответствия содержимого раздела (подраздела, пункта, подпункта) его наименованию (заголовку), от своего рода «релевантности». Редакция от 20.06.2018.

Проверка содержимого разделов документов

Создан 19.10.2009 12:15:27

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

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

- Правильный стиль изложения

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

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

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

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

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

- Контакты ООО «Техническая документация»

Заказать услуги ООО «Техническая документация» можно по эл. почте admin @ tdocs . su (без пробелов), по тел. 8-910-468-09-28 или в форме Контакты.

Copyright © ООО «Техническая документация» 2018. Заимствуйте наши материалы с блеском! При воспроизведении материалов портала обязательна установка активной гиперссылки на источник — страницу с этой публикацией на tdocs.su.

Яндекс.Метрика