Всё для технического документирования
+7 (495) 001-00-42
Разработка технической документации
Курсы для технических писателей
Программное обеспечение

Рецензия на книгу «Каждая страница – это первая страница». Добавьте её к арсеналу

28.03.2014

В 2013 году Марк Бейкер выпустил интересную и, несомненно, полезную для многих книгу «Каждая страница – это первая страница». Представляем вам рецензию на данную книгу, сделанную Рейчел Хотон, техническим писателем с более чем 14-летним стажем работы.


С большими ожиданиями я взяла свой ??собственный подписанный экземпляр книги Марка Бейкера «Каждая страница – это первая страница» на мероприятии LavaCon 2013 года. Я даже взяла вторую копию для местного отделения научно-технического центра, чтобы разыграть его в качестве приза на следующем заседании. Потом меня попросили дать рецензию на эту книгу для TechWhirl.

Шумиха вокруг этой книги на LavaCon и в других средствах массовой информации не обманула моих ожиданий. Я была рада видеть, что автор подтвердил мои давнишние предположения – пользователи больше не хотят смотреть или что-то искать в справке или документации. Они хотят искать в Google, причём искать не только вашу имеющуюся документацию, но и опыт других людей по данной проблеме.

Марк разделил свою книгу на три части: контент в веб-контексте, характеристики топиков «каждая страница – это первая страница» и написание топиков «каждая страница – это первая страница»

Контент в веб-контексте

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

Именно так. «Спрятанный» контент до пользователя не дойдёт. Что вы хотите, чтобы пользователи видели при запросе в Google? Результаты поиска, которые включают тщательно продуманный контент вашей компании. Что пользователи получают, если при поиске ваш контент спрятан? Они всегда получают смешанные результаты поиска, некоторые из которых не будут положительными, и пользователи никогда не увидят ваш контент, если кто-то не скопирует его в другое место.

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

Характеристики топиков «каждая страница – это первая страница»

В этом разделе Марк охватывает два широких класса топиков: структурные элементы и предметные топики. Я согласна с тем, как он организовал этот раздел, и его примеры легко понять.

Топики структурных элементов должны органично вписаться в контекст и либо зависеть от контекста, либо быть контекстно-независимыми. Зависимому от контекста топику предшествует вводный топик, а затем заключительный – это хорошо заметно в книжном формате. Контекстно-независимые топики «как конструктор Lego – их можно соединять в любом порядке, но только некоторые из таких конструкций будут иметь смысл».

Предметный топик – единица контента, которую получает пользователь. Марк утверждает, что все топики «каждая страница – это первая страница» (EPPO – every page is page one) являются предметными, но не все предметные топики являются EPPO-топиками.

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

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

В разделе 6.8 Марк охватывает характеристики EPPO-топиков: автономные, специфичные и топики для ограниченных целей; установите тип, утвердите контекст, предполагая, что читатель квалифицирован, оставайтесь на одном уровне и давайте большое количество ссылок. Главы 7-13 рассказывают много деталей о каждой характеристике, предоставляя полезные примеры и информацию для облегчения понимания читателем.

Написание топиков «каждая страница – это первая страница»

На этом моменте книги я стала не читать, а просматривать. Информация, содержащаяся в данном разделе, в основном, вязнет в деталях. Я бы не стала читать весь этот раздел, а только по принципу «если нужно». Главы 14-21 рассказывают о написании EPPO-топиков. Хотите узнать больше о выборе последовательности задач или последовательности топиков? Сразу переходите к главе 16, пропустив главы 14 и 15. Глава 19 чрезвычайно полезна для меня, так как охватывает метаданные, и, в частности, добавление хороших метаданных. «Без явных метаданных поисковые системы будут пытаться извлечь метаданные из самого контента. Веб управляется с помощью метаданных». Неплохо использовать метаданные в первом разделе книги, чтобы убедиться, что пользовательские фильтры не отфильтровывают ваш контент.

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

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

Источник: Book Review: Every Page is Page One is One to Add to your TechComm Toolbox

Тэги: , ,

< Вернуться к списку публикаций

Облако тегов