Улучшение навигации в бумажных документах с применением AuthorIT

Приемы улучшения навигации в бумажных документах (и в их исходных электронных версиях) с учетом требований ГОСТ 2.105 с применением AuthorIT. Отмечено автоматическое улучшение ряда оценочных факторов удобства применения по ГОСТ 28195-89. Редакция от 06.10.2014.

Создан 20.01.2012 14:26:14

Забегая немного вперед: версия настоящей статьи в формате pdf, позволяющая попробовать, как работает улучшенный поиск в электронном документе, находится здесь.

- Бумажные носители нужны!

Сначала, как водится, надо обязательно что-нибудь нарушить - Ржунимагу! (смайл) Самим названием статьи (и ее заголовками) грубейшим образом попирается ГОСТ 2.105, поскольку:

«В тексте документа не допускается:

  • применять обороты разговорной речи, техницизмы, профессионализмы;
  • применять для одного и того же понятия различные научно-технические термины, близкие по смыслу (синонимы), а также иностранные слова и термины при наличии равнозначных слов и терминов в русском языке;
  • применять произвольные словообразования;
  • применять сокращения слов, кроме установленных правилами русской орфографии, соответствующими государственными стандартами, а также в данном документе;
  • сокращать обозначения единиц физических величин, если они употребляются без цифр, за исключением единиц физических величин в головках и боковиках таблиц, и в расшифровках буквенных обозначений, входящих в формулы и рисунки.

[из п. 4.2.3 ГОСТ 2.105]»

Само понятие навигации в документах является профессионализмом во втором толковании этого слова:

ПРОФЕССИОНАЛИЗМ -а; м. 2. Лингв. Слово или оборот речи, характерные для речи людей какой-л. профессии. Злоупотреблять профессионализмами. Изучать профессионализмы. Большой толковый словарь русского языка. - 1-е изд-е: СПб.: Норинт. С. А. Кузнецов. 1998.

В свое оправдание отметим, что слово «навигация» давно уже стало общеупотребительным (навигация по разделам, навигация по сайту), оно значительно короче словосочетания «переход от раздела к разделу в документе» да и сам процесс отражает достаточно точно.

Теперь о сути проблемы. Не секрет, что документы бывают как электронные, так и бумажные. Нет секрета и в том, что навигация в электронных и бумажных версиях одного и того же документа, несмотря на то, что структура (построение) у них одинакова, существенно различается.

Смотрите:
О навигации в документах
Пути улучшения навигации в бумажных документах
Практические приемы улучшения навигации в бумажном документе с применением AuthorIT
Элементы навигации, предусмотренные ГОСТ 2.105
Автоматическое улучшение оценочных факторов удобства применения

О навигации в документах

Смотрите:
Навигация в электронных документах
Навигация в бумажных документах

Навигация в электронных документах

Кратко о навигации в электронных документах. Всем известно (но мало кто этим пользуется), что в документах ворда можно автоматически собирать содержание (оглавление в терминах ворда) и просматривать автоматически создаваемую на его основе схему документа, при условии, что к разделам, подразделам, пунктам и подпунктами применены стили заголовков (Заголовок 1, Заголовок 2, Заголовок 3 и Заголовок 4). Примеры содержания и схемы документа приведены на рисунках ниже.

- Содержание документа

Помимо содержания и схемы документа можно организовывать и переходы по ссылкам (перекрестным или гиперссылкам) к любому месту в документе. Делается это просто:

  1. Указателем мыши обозначается место в документе, к которому предусмотрен переход по ссылке;
  2. Командами меню ВставкаЗакладка в указанном месте документа создается закладка. В терминологии языка разметки HTML закладка называется якорем (anchor);
  3. Командами ВставкаГиперссылка или ВставкаСсылкаПерекрестная ссылка добавляется собственно ссылка на ранее созданную закладку.

- Схема документа в ворде

На рисунке ниже изображены результаты перечисленных выше действий.

- Перекрестные и гиперссылки в документе

Подводя итоги по подразделу, можно смело утверждать, что с навигацией в электронных документах все обстоит относительно благополучно, если, конечно, с умом (применением стилей заголовков) ее организовывать. Навигация, построенная на применении содержания, схемы документа и ссылок, достаточно развита, т.е. совершать переходы внутри документа довольно удобно. А какова ситуация с навигацией в бумажных документах?

Навигация в бумажных документах

В бумажных документах с навигацией дело обстоит значительно хуже, ведь гиперссылки на бумаге почему-то не работают... В итоге единственным элементом навигации остается содержание. Вернемся к крайнему рисунку, представив себе, что у нас в руках не распечатка небольшой статьи, а документ листов на триста...

Как разыскать подраздел Навигация в бумажных документах по его названию? Только путем возврата к содержанию, расположенному в самом начале документа. Следует отметить, что само содержание, собранное из заголовков четырех уровней, займет (в большом серьезном документе) не менее 10 листов. Итак, находим название требуемого подраздела, соответствующий ему номер страницы, а затем, путем перелистывания, перемещаемся к искомому подразделу на уже известной странице.

Как разыскать тот же подраздел, но уже не по названию, а по его номеру? Повторив те же манипуляции. А если необходимо отыскать не безобидный пункт 1.2.2, а некий подпункт 4.8.3.6.2.1.7 (7-го уровня), которого в содержании и быть не должно, поскольку оно формируется только из заголовков с 1-го по 4-й уровень?

Подводя итоги по подразделу, можно утверждать, что навигация в бумажных документах фактически не предусмотрена, что здорово раздражает. А если представить, что идет приемка-сдача работы, в сборе вся приемочная комиссия, состоящая из серьезных и очень занятых людей, у которых сегодня еще куча дел и нерешенных вопросов? Обстановка и без того нервозная, а тут еще какой-то разгильдяй от исполнителя дрожащими пальцами перелистывает страницы, судорожно пытаясь найти в документе пресловутый подпункт 4.8.3.6.2.1.7? Да ужас - Круглые глаза

Как же улучшить навигацию в бумажных документах, дабы сберечь нервы себе и ближнему своему?

Пути улучшения навигации в бумажных документах

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

Есть два пути улучшения навигации:

  1. Организация гиперссылок (перекрестных ссылок) с указанием наименования раздела (подраздела и проч.) и номера страницы. Выглядит это так;

    - Ссылка с наименованием раздела и номером страницы
  2. Организация дополнительных элементов навигации в виде содержаний, приведенных в каждом разделе (подразделе) документа, см. рисунок ниже.

    - Дополнительное содержание в разделах документов

Реализовать перечисление 1 можно вручную в ворде путем длительных манипуляций, см. Навигация в электронных документах. В программе AuthorIT, как будет показано ниже, все это делается одной операцией типа drag-and-drop. А вот как реализовать средствами ворда перечисление 2... Для автора статьи это остается загадкой.

Выгода очевидна: в первом случае сразу видно, что для перехода к разделу Навигация в электронных документах надо открыть страницу 5, во втором случае имеется перечисление (с номерами страниц) всех подразделов в составе данного раздела. Все просто, наглядно и удобно.

Теперь об организации гиперссылок и содержаний разделов (с номерами страниц) с применением AuthorIT.

Практические приемы улучшения навигации в бумажном документе с применением AuthorIT

Смотрите:
Организация гиперссылок (перекрестных ссылок) с указанием наименования раздела (подраздела и проч.) и номера страницы
Организация дополнительных элементов навигации в виде содержаний, приведенных в каждом разделе (подразделе) документа

Организация гиперссылок (перекрестных ссылок) с указанием наименования раздела (подраздела и проч.) и номера страницы

Об организации гиперссылок (перекрестных ссылок) с указанием наименования раздела (подраздела и проч.) и номера страницы подробно рассказано в подразделе 5.1.2 Организация гиперссылок (стр. 51) учебного пособия по AuthorIT, поэтому нет особого смысла повторяться.

Организация дополнительных элементов навигации в виде содержаний, приведенных в каждом разделе (подразделе) документа

Об организации дополнительных элементов навигации в виде содержаний, приведенных в каждом разделе (подразделе) документа (только с точностью до наоборот) подробно рассказано в подразделе 4.8.5 Удаление содержания раздела (стр. 39) той же книги, но, поскольку задача сейчас стоит прямо противоположная, придется показать детали. Итак, для создания содержаний в разделах и подразделах следует:

  1. Найти шаблон First Chapter, см. рисунок ниже;

    - Местоположение шаблона First Chapter
  2. Открыть его и привести к виду, показанному на рисунке ниже.

    - Шаблон First Chapter с внесенными изменениями

На вкладке Special Links должен быть установлен флажок Child Topics. Оба шага следует повторить и для шаблонов Chapter, после этого в разделах и подразделах документа ворда образуются дополнительные (локальные) содержания, см. рисунок ниже.

- Дополнительное содержание в разделах документов

Справедливости ради надо добавить еще, что:

  • в AuthorIT предусмотрена расширенная навигация - переход к предыдущему и последующему разделам, к содержанию, к индексу, см. рисунок ниже, но все это не является актуальным для бумажного документа;

    - Расширенная навигация в AuthorIT
  • если отметить флажок HTML/HTML Help, то все включенные элементы навигации будут работать и в указанном формате. Это неплохо для реализации и на сайте, но слишком хорошо - тоже нехорошо.

Элементы навигации, предусмотренные ГОСТ 2.105

А этот подраздел предусмотрен специально для зануд, чтобы показать им, что ГОСТ 2.105 нарушен не был.

Смотрите:
Содержание
Ссылки
Сноски
Кратко о построении документов по ГОСТ 2.105

Содержание

Вот все, что сказано в ГОСТ 2.105 о содержании:

«В документе (части, книге) большого объема на первом (заглавном) листе и, при необходимости, на последующих листах помещают содержание, включающее номера и наименования разделов и подразделов с указанием номеров листов (страниц).

Если документ разбит на части (книги), то в конце содержания первой части (книги) перечисляют обозначение и наименование (при наличии) остальных частей (книг). Содержание включают в общее количество листов данного документа (части, книги).

Слово «Содержание» записывают в виде заголовка (симметрично тексту) с прописной буквы. Наименования, включенные в содержание, записывают строчными буквами, начиная с прописной буквы [из п. 4.1.11 ГОСТ 2.105]»

Отсюда следует, что никто не вправе запретить создание дополнительных (локальных) содержаний в разделах и подразделах документа, см. Организация дополнительных элементов навигации в виде содержаний, приведенных в каждом разделе (подразделе) документа.

Ссылки

Возвращаемся к ГОСТ 2.105:

«В текстовом документе допускаются ссылки на данный документ, стандарты, технические условия и другие документы при условии, что они полностью и однозначно определяют соответствующие требования и не вызывают затруднений в пользовании документом.

Ссылки на стандарты предприятий (СтП) и другую техническую документацию должны быть оговорены в договоре на разработку изделия.

Ссылаться следует на документ в целом или его разделы и приложения. Ссылки на подразделы, пункты, таблицы и иллюстрации не допускаются, за исключением подразделов, пунктов, таблиц и иллюстраций данного документа.

При ссылках на стандарты и технические условия указывают только их обозначение, при этом допускается не указывать год их утверждения при условии записи обозначения с годом утверждения в конце текстового документа под рубрикой «ССЫЛОЧНЫЕ НОРМАТИВНЫЕ ДОКУМЕНТЫ» по форме:

Обозначение документа, на который дана ссылка

Номер раздела, подраздела, пункта, подпункта, перечисления, приложения, разрабатываемого документа, в котором дана ссылка

При ссылках на другие документы в графе «Обозначение документа» указывают также и наименование документа. При ссылках на раздел или приложение указывают его номер [из п. 4.2.22 ГОСТ 2.105]»

Для нас представляет интерес только фрагмент текста, выделенный жирным шрифтом, из которого следует, что в пределах одного документа можно ссылаться на любые его элементы.

Сноски

И снова ГОСТ 2.105: «Если необходимо пояснить отдельные данные, приведенные в документе, то эти данные следует обозначать надстрочными знаками сноски.

Сноски в тексте располагают с абзацного отступа в конце страницы, на которой они обозначены, и отделяют от текста короткой тонкой горизонтальной линией с левой стороны, а к данным, расположенным в таблице, в конце таблицы над линией, обозначающей окончание таблицы [из п. 4.5.1 ГОСТ 2.105]»

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

Кратко о построении документов по ГОСТ 2.105

Согласно п. 4.11 ГОСТ 2.105 текст документа при необходимости разделяют на разделы и подразделы. Далее (оттуда же):

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

и

«Пункты, при необходимости, могут быть разбиты на подпункты, которые должны иметь порядковую нумерацию в пределах каждого пункта, например: 4.2.1.1, 4.2.1.2, 4.2.1.3 и т.д. [из п. 4.1.6 ГОСТ 2.105]»

А эти три пункта косвенно подтверждают то, что содержание документа должно формироваться из заголовков не ниже 4-го уровня, см. Навигация в бумажных документах.

Автоматическое улучшение оценочных факторов удобства применения

В таблице 7 ГОСТ 28195-89 выделены оценочные элементы, по которым бумажный документ с улучшенной навигацией автоматически зарабатывает единицы.

Код элемента

Наименование

Метод оценки

Оценка

У0101

Возможность освоения программных средств по документации

Экспертный

0-1

У0102

Возможность освоения ПС на контрольном примере при помощи ЭВМ

То же

0-1

У0103

Возможность поэтапного освоения ПС

»

0-1

У0201

Полнота и понятность документации для освоения

»

0-1

У0202

Точность документации для освоения

»

0-1

У0203

Техническое исполнение документации

»

0-1

У0301

Наличие краткой аннотации

»

0-1

У0302

Наличие описания решаемых задач

»

0-1

У0303

Наличие описания структуры функций ПС

»

0-1

У0304

Наличие описания основных функций ПС

»

0-1

У0306

Наличие описания частных функций

»

0-1

У0307

Наличие описания алгоритмов

»

0-1

У0308

Наличие описания межмодульных интерфейсов

»

0-1

У0309

Наличие описания пользовательских интерфейсов

»

0-1

У0310

Наличие описания входных и выходных данных

»

0-1

У0311

Наличие описания диагностических сообщений

»

0-1

У0312

Наличие описания основных характеристик ПС

»

0-1

У0314

Наличие описания программной среды функционирования ПС

»

0-1

У0315

Достаточность документации для ввода ПС в эксплуатацию

»

0-1

У0316

Наличие информации технологии переноса для мобильных программ

»

0-1

У0401

Соответствие оглавления содержанию документации

»

0-1

У0402

Оценка оформления документации

»

0-1

У0403

Грамматическая правильность изложения документации

»

0-1

У0404

Отсутствие противоречий

»

0-1

У0405

Отсутствие неправильных ссылок

»

0-1

У0406

Ясность формулировок и описаний

»

0-1

У0407

Отсутствие неоднозначных формулировок и описаний

»

0-1

У0408

Правильность использования терминов

»

0-1

У0409

Краткость, отсутствие лишней детализации

»

0-1

У0410

Единство формулировок

»

0-1

У0411

Единство обозначений

»

0-1

У0412

Отсутствие ненужных повторений

»

0-1

У0413

Наличие нужных объяснений

»

0-1

У0501

Оценка стиля изложения

»

0-1

У0502

Дидактическая разделенность

»

0-1

У0303

Формальная разделенность

»

0-1

У0504

Ясность логической структуры

»

0-1

У0505

Соблюдение стандартов и правил изложения в документации

»

0-1

У0506

Оценка по числу ссылок вперед в тексте документов

»

0-1

У0601

Наличие оглавления

Экспертный

0-1

У0602

Наличие предметного указателя

То же

0-1

У0603

Наличие перекрестных ссылок

»

0-1

У0604

Наличие всех требуемых разделов

»

0-1

У0605

Соблюдение непрерывности нумерации страниц документов

»

0-1

У0606

Отсутствие незаконченных разделов абзацев, предложений

»

0-1

У0607

Наличие всех рисунков, чертежей, формул, таблиц

»

0-1

У0608

Наличие всех строк и примечаний

»

0-1

У0609

Логический порядок частей внутри главы

»

0-1

У0701

Наличие полного перечня документации

»

0-1

У0801

Уровень языка общения пользователя с программой

»

0-1

У0802

Легкость и быстрота загрузки и запуска программы

»

0-1

У0803

Легкость и быстрота завершения работы программы

»

0-1

У0804

Возможность распечатки содержимого программы

»

0-1

У0805

Возможность приостанова и повторного запуска работы без потерь информации

»

0-1

У0901

Соответствие меню требованиям пользователя

»

0-1

У0902

Возможность прямого перехода вверх и вниз по многоуровнему меню (пропуск уровней)

»

0-1

У1001

Возможность управления подробностью получаемых выходных данных

»

0-1

У1002

Достаточность полученной информации для продолжения работы

»

0-1

У1101

Обеспечение удобства ввода данных

»

0-1

У1102

Легкость восприятия

»

0-1

У1201

Обеспечение программой выполнения предусмотренных рабочих процедур

»

0-1

У1202

Достаточность информации, выдаваемой программой для составления дополнительных процедур

»

0-1