Глава 3. Структура

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

Сохраните эту структуру. Это поможет читателям использовать структуру «дерево» как основу для книги: это даст им представление о том, где они находятся. Вы также можете использовать эту структуру для организации файлов в каталогах.

Вы также должны иметь в виду:

• Читатели заранее должны представлять себе структуру

• Идея перекрывающихся деревьев

• Насколько большим должен быть документ

• Ссылка или копия

Структура для читателя

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

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

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

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

• Если вы одновременно пишете для нескольких групп, тогда вы должны поддерживать оба подхода.

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

Например, «Если Вы действительно хотите узнать, как это работает, смотрите Internals guide», или «Введение step-by-step можно найти в обучающей части».

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

Обеспечьте два различных «корня» для вашего дерева. Например, вы можете написать step-by-step обучающую часть и функциональное ссылочное дерево для тех же данных. Оба дерева опираются на нижнем уровне на одни и те же данные, но в то время, как первое разбирается сначала с простейшими понятиями, второе может быть сгруппировано по функциональным признакам. Это все равно, что создать несколько указателей для одной и той же книги. Обучающая часть может также содержать информацию, которой нет в функциональном дереве.

Перекрывающиеся деревья

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

Размер документа

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

Документ может быть совсем малым по размеру. Например, примечание.

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

Читатели обычно пролистывают длинные документы используя scroll bar. Когда scroll bar немного перемещается, документ должен перемещаться на соответственное малое значение, так, чтобы часть оригинального окна осталась видимой. Это позволяет читателю сканировать документ. Если документ оказывается больше, тогда он становится нечитаемым и, при каждом передвижении scroll bar, читатель может потерять место на котором он остановился.

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

Также они не приносят авторам неприятностей создания (или генерирования) большого количества связей и постоянного их обновления в случае изменения данных. Если создание ссылок является проблемой используйте в документе только одну ссылку — на страницу содержания. Некоторые просмотрщики имеют кнопки «next» и «previous», позволяющие просматривать документы по списку.

Приблизительным руководством по размеру документа может служить:

• Для online help, menu, дающих доступ к другим материалам лучше не превышать 24 линии. Проверьте это утверждение сидя за текстовым терминалом.

• Для текстовых документов — примерно 2.5 листа формата A4.

Ссылка или копия?

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

Имеется несколько причин оставить информацию на прежнем месте:

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

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

Причины для копирования:

• Если информация носит временный характер, например статья, есть смысл ее скопировать

• У вас может появиться желание ссылать на определенную версию чего-либо, что может быть изменено и не сохранено в архиве.

Вам следует быть очень осторожными прежде чем ссылаться на ваши личные коллекции, которые дублируют официальные коллекции:

• Internet FAQ (Frequently Asked Questions)

• RFCs (Request For Comments)

• Information by subject

• The «best» URLs on the web. Создайте личный список указателей ваших интересов.