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

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

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

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

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

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

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

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

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

(Вернуться к Обзору , назад к Введению , по теме: написание каждого документа )

Tim BL

Оригинальная версия этого документа.