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

Что такое структурированное писательство?

18.06.2015

Статья входит в цикл «Понимание и применение структурированного писательства».

От редактора: Марк Бейкер начинает свою постоянную серию публикаций по структурированному писательству с создания рабочего определения. В дальнейшем читайте статьи о ключевых концепциях структурированного писательства и их практическом применении.


Я не любитель широких определений больших терминов. Определения должны прояснять значение, но попытки определить такие термины как «контент» и «контент-стратегия» лишь вызывают споры. Предлагаемые определения часто рассчитаны не столько на то, чтобы прояснить значение, как на то, чтобы застолбить некоторую область. Так же и сочетанию «структурированное писательство», по сути, требуется что-то вроде определения, не потому что его значения размыты, а потому что они сильно разнятся. Это результат разнородности интересов, а не отсутствия определения. Моё определение — это декларация моих интересов, не более.

Давайте начнём с как можно более общего определения типа «обхвати-руками-всё-сразу»:

Структурированное писательство — это акт создания контента, удовлетворяющего одному или более ограничениям.

Что такое ограничение? Любое правило, которое формирует, определяет контент или заключает его в какие-либо рамки. Примеры:

  • Заголовки второго уровня могут использоваться только под заголовками первого уровня.
  • Рецепт должен содержать каждый используемый ингредиент и его количество.
  • Справка по API должна определять возвращаемый тип функции.
  • Список должен содержать по меньшей мере один элемент.
  • Имя человека должно включать в себя обращение.
  • Все птицы должны быть определены с помощью формальных имен по таксономии Линнея.
  • Точка с запятой используется для связи двух независимых частей предложений.
  • Начинайте каждое предложение с прописной буквы.

Возможно, вы видите здесь проблему. По этому определению любое писательство, за исключением, вероятно, каракулей двухлетнего ребёнка, структурировано. И, фактически, так и есть. У любого контента есть структура. Без структуры в нём не будет смысла.

Так что наше определение типа «обхвати-руками-всё-сразу» хотя и корректно, но не сильно полезно. Нам необходимо как-то его ограничить.

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

Это ограничение несколько неопределённое, и поэтому результаты поиска не всегда точны. Большинство страниц, по которым Google осуществляет поиск, не сообщают в явном виде об ограничениях, которым они соответствуют в общепринятом виде, так что поисковый движок должен пытаться экстраполировать те ограничения, которым следует страница, и те ограничения, которые хотел выразить читатель своей поисковой строкой. Принимая во внимание погрешность на обеих сторонах, удивительно то, что Google работает так хорошо.

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

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

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

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

И это вызывает вопрос о том, зачем вообще записывать ограничения? Почему бы просто не следовать им во время написания, предполагая, что читатель распознает их в контексте?

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

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

Получается, структурированное писательство играет роль и в создании контента, и в управлении им. Как термин, «структурированное писательство» — часть кластера терминов, включающего также «структурированный авторинг», «структурированный контент» и, с недавних пор, «умный контент». Некоторые сообщества предпочитают один термин другому. Производители инструментов, например, почти всегда используют термин «структурированный авторинг». Многие контент-стратеги с недавних пор стали адептами «умного контента».

У всех этих терминов одна центральная точка, если даже не всегда те же границы. «Умный контент», в частности, означает определённое применение структурированного писательства, т.е., скорее, просто является синонимом (хотя если он станет более популярным, применение этого термина неизбежно будет более частым). И, очевидно, есть разница в акценте между «авторингом» (процессом), «контентом» (сущностью) и «писательством» (процессом и сущностью). Я выбрал использование «структурированного писательства» для этой серии публикаций, потому что этот термин покрывает три стороны: акт написания (писательство как действие); акт управления (писательство — или контент — как управляемый актив) и потребление (писательство как потребляемый продукт).

В плане управления, предположим, мы управляем совокупностью контента, который включает в себе рецепты, и мы хотим выбрать все рецепты, которые хорошо соответствуют Пино Нуар [красный сорт винограда, а также вина из этого сорта винограда – прим. пер.]. Мы можем попытаться сделать это в стиле Google, осуществив поиск «рецепт Пино Нуар». Поиск, возможно, выдаст нам множество корректных результатов, но, вероятно, также некоторые из них будут некорректными. Слова «рецепт» и «Пино Нуар» могут содержать другие типы контента (такие, как этот очерк об определении структурированного писательства). Некоторые рецепты могут использовать Пино Нуар как ингредиент, а не как вино. Некоторые рецепты могут быть утеряны, потому что не включают слово «рецепт» (большинство не включают).

Мы могли бы получить лучшие результаты, если бы могли сделать запрос по двум явным полям. Например, так:

RETURN topic WHERE type=’recipe’ AND wine-match=’pinot noir’

[Суть запроса: показать топики, тип которых «рецепт», а также упоминается вино «Пино Нуар» — прим. пер.]

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

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

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

Так что давайте ещё ограничим наше определение:

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

Имейте в виду, что контент, который был структурирован для одной цели, может также оказаться структурированным для другой цели. На самом деле, это часто оказывается так. С другой стороны, это означает, что вы никогда не можете предугадать, что структура, применённая к вашему контенту сегодня, будет применена для будущих целей, которых вы ещё не осознаёте. В этом смысле идея, что структурированное писательство может ваш контент «подготовить к будущему» — обманчива. Это может лишь гарантировать будущее использование того, что вы предвосхищаете сегодня.

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

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

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

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

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

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

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

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

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

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

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

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

Я мог бы сказать «с целью обладания форматом хранения контентом, чтобы я на самом деле владел контентом и его возможностями».

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

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

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

 

 

Источник: What is Structured Writing?

Тэги: , , , , ,

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

Облако тегов