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

Новости о техническом писательстве

Структурированное писательство: работа в домене документа

04.12.2015

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

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


Как мы увидели в нашем исследовании домена носителя, текстовые процессоры и настольные издательские системы склонны метаться между доменом носителя (как выглядит документ) и доменом документа (как он организован). Когда они построены на основном наборе объектов домена документа — страницы, абзацы, таблицы и т.д. — они используют WYSIWYG-отображение, чтобы сохранить работу и мысль автора практически в терминах стиля и форматирования — ограничения домена носителя. Это приводит к затруднениям при применении к работе автора важных ограничений домена документов или при записи ограничений, которым следует автор. Для этого нам требуется переместиться в домен документа. Читать дальше…



Структурированное писательство: работа в домене носителя

23.09.2015

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

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


Домен носителя — это домен структурированного писательства, в котором структуры имеют отношение к носителю, в котором отображается контент. Такой контент часто считается «неструктурированным», но на самом деле это означает «неструктурированный так, как это в настоящий момент нужно мне». Фактически любой контент имеет структуру, и мы действительно можем найти шаблоны и техники для всех форм структурированного писательства в домене носителя. Это делает этот домен хорошим предметом для изучения основ структурированного писательства. Читать дальше…



Три домена в структуре контента

13.08.2015

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

00Настоящая статья Марка Бейкера по структурированному писательству рассказывает, каким образом три домена контента работают на структурный контент. Ознакомьтесь с его первой статьёй, если хотите узнать больше о том, как Марк определяет структурированное писательство.


 

От идеи к точкам

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

В самом простом случае автор записывает свои идеи с помощью ручки и бумаги. Полное преобразование идей в точки происходит в голове автора. Контент записывается напрямую в окончательной физической форме.

Читать дальше…



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

18.06.2015

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

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


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

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

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

Читать дальше…



Адвокат пользователя: структурированный контент и потребности пользователя

06.03.2015

01Марк Бейкер завершает свою серию статей под названием «Адвокат пользователя» и строит мост к новой серии публикаций под своим авторством. В данной статье речь идёт о том, насколько структурированное писательство отвечает интересам пользователей.


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

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



Адвокат пользователя: Пользователь и право знать (часть 2)

31.10.2014

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


Теперь мы ожидаем, что информацию можно будет получить бесплатно и без усилий.

Что это значит для технического писателя и разработчика контент-стратегии?

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

Читать дальше…



Адвокат пользователя: Пользователь и право знать (часть 1)

29.10.2014

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


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

Так пишет Уилл Лейтч в примечательной статье о фатальной аварии на маленькой региональной грунтовой дороге. Авария примечательна только тем, что одним из участников стал Тони Стюарт, трёхкратный чемпион NASCAR. Но это неважно. Такую же статью можно было написать неделей позже о Фергюссоне, штат Миссури. Или о любом событии, ответов на которое мы требуем в течение недели после прочтения. Тема Лейтча проста – о наших ожиданиях получать ответы на все наши вопросы, получать правду о любом событии, которое нас заинтересовало, и получать её немедленно. Читать дальше…



Что такое минимализм (часть 3)

29.11.2013

01Часть третья статьи о минимализме – о том, как преодолеть существующую ментальную модель пользователей и зачем это нужно.


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

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

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

Читать дальше…



Что такое минимализм (часть 2)

27.11.2013

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


Приспособление к парадоксу придания смысла – это фраза Джона Кэрролла (John Carroll), использованная для описания того, что он или его коллеги узнали путём эксперимента над тем, как люди изучают компьютерные системы. Что мы могли ожидать: люди с наименьшими знаниями системы должны были полагаться на документацию больше всех, для того чтобы она провела их через незнакомые дебри. Новички читают документы; эксперты могут понять всё сами – это классическая модель. Кэрролл же выяснил, что всё с точностью до наоборот: чем меньше люди знают и меньше опыта имеют, тем меньше они читают документацию.

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

Читать дальше…



Что такое минимализм (часть 1)

25.11.2013

01Представляем первую часть статьи Марка Бэйкера о том, что такое минимализм в технической документации и как его достичь. В первой части речь идёт о причинах необходимости стремления к минимализму.


Спросите, что такое минимализм (в контексте технических коммуникаций), и вы, скорее всего, придёте к цитированию четырёх принципов минимализма.

Согласно Джо-Энн Хэкос (JoAnn Hackos), основные четыре принципа минимализма такие:

Принцип 1: Выбирайте подход, ориентированный на действие.

Принцип 2: Делайте документ удобным с точки зрения поиска нужной информации.

Принцип 3: Обеспечьте доступ пользователя к информации об ошибках и их устранении.

Принцип 4: Обеспечьте информацией о том, как сделать, как научиться и как систематизировать.

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

Читать дальше…