Авторинг на основе тем и модульный авторинг

Это сложный вопрос — настолько сложный, что я написал об этом книгу: Каждая страница — первая страница: тематическое письмо для технических коммуникаций и Интернета от XML Press ( https://xmlpress.net/publications/eppo/ ) .

В основе путаницы лежит двусмысленность в отношении того, что означает слово «тема».

Долгое время мы использовали слово «тема» для обозначения короткого самостоятельного фрагмента информации по одной теме: например, раздела справки. Тема была единицей потребления. Рецепт – это тема. Статья в Википедии — это тема. Man-страница — это тема.

Тем временем Роберт Хорн разработал теорию отображения информации, которая утверждала, что вы можете улучшить письмо, разбивая документ на разделы одного из шести (первоначально семи) типов информации: процедура, процесс, принцип, концепция, структура и факт. В информационном отображении документ представлял собой карту, состоящую из блоков различных типов информации. Это было не совсем модульное написание — это было скорее вопросом модульного дизайна — но оно представило идею о том, что большой документ может состоять из более мелких отдельных частей. ( https://en.wikipedia.org/wiki/Information_mapping )

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

Затем исследования в Xerox PARK привели к теории сбора информации, которая гласит, что люди ищут информацию так же, как дикие животные ищут пищу — следуя по запаху информации и пытаясь свести к минимуму расход калорий. Эта теория подтвердила выводы Кэрролла. ( https://www.nngroup.com/articles/information-scent/ )

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

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

Вот тут и началась путаница. В то время как Information Mapping назвал эти единицы «блоками», DITA решила назвать их «темами». Как и в случае информационного отображения, документ в DITA представляет собой карту. Однако в DITA документ — это карта тем , а не блоков. Таким образом, в DITA «авторство на основе темы» стало означать изолированное написание отдельных многократно используемых частей документа. В то время как тема в смысле «Каждая страница» — это страница One — это единица, доставляемая читателю, тема в смысле DITA — это единица, которую пишет автор, и часто ее приходится комбинировать с другими единицами, чтобы сделать что-то полезное для читателя.

Например, в смысле ЕОКЗР рецепт — это одна тема. Однако в подходе DITA рецепт состоит из одной концептуальной темы (введение), одной справочной темы (список ингредиентов) и одной темы-задачи (инструкции по приготовлению), соединенных картой. (Не каждый практикующий DITA зайдет так далеко, но это иллюстрирует принцип.) Таким образом, у нас есть два разных значения «темы» и два разных значения «тематического письма».

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

Я подозреваю, что эта продолжающаяся путаница связана с тем, что, если вы пишете на основе темы в смысле «Каждая страница — это первая страница», вы почти наверняка не строите свои короткие статьи из отдельно управляемых блоков. Люди, которые этим занимаются, собирают большие работы. Обе группы практиков используют одни и те же термины для описания того, что они делают, но делают они совершенно разные вещи.

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

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

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

Используя авиационное руководство в качестве примера в тематическом подходе, авторов могут попросить высказать свое мнение о конкретных операциях, погрузке и разгрузке товаров, «правильных» настройках для запуска данного самолета, навигации в случае отказа приборов. , и т. д. Поочередно работа может быть смоделирована в нескольких нормативно-правовых средах, при этом авторов просят высказать свое письменное мнение по ряду тем в рамках определенного нормативно-правового пространства, например, один автор охватывает все операционные стандарты в ЕС, другой - Россию и Россию. треть для Северной Америки.