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

Публикации

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

18.06.2015

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

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


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

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

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

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



9 факторов, влияющих на качество контента

10.06.2015

00Понятие качества – вещь сложная, а когда дело касается контента, то, как и при оценке любого неосязаемого явления, вообще затруднительно найти подход. Что оценивать? Стиль? Так это необъективное понятие. Подачу материала? Встаёт вопрос: а как? Какой контент имеет больший вес – инструкция к продукту или маркетинговые материалы? А надо ли вообще об этом задумываться? Много вопросов, и непонятно, с какой стороны подойти. Джилл Парман, владелец компании ForWord Consulting, утверждает, что создание и поддержка качественного контента – это вызов, и она знает, как его принять. Давайте вместе с ней разберёмся, какие критерии являются решающими при оценке качества и что с ними делать, чтобы добиться результата.


Встаньте на путь к хорошему контенту, оценив качество по показателям

Посмотрите в нескольких словарях определение слова «качество» и вы обнаружите много вариантов. Поговорите с людьми, которые управляют организациями, руководят командами по обеспечению качества или ведут блог о моде или еде, и у вас появится ещё больше определений. Одно из базовых определений описывает качество так: «в какой степени что-то хорошо или плохо». Другое продвигается на шаг вперёд и предполагает, что именно указывает на качество: «высокий уровень полезности и мастерства» (оба взяты отсюда: http://www.merriam-webster.com/dictionary/quality). Значит, определить, что представляет собой качественная документация, учебные материалы или вебсайты, раз уж вы взаимодействуете с этими материалами – легко, верно? Ну, да вы уже знаете ответ на этот вопрос. Читать дальше…



3 основные ошибки управления контентом в компаниях

21.05.2015

Бывает, что в компании есть огромное количество контента. Например, вы производите множество программных продуктов, каждый из которых обновляется, имеет разные версии (положим, для стационарных ПК и мобильных устройств), к каждому продукту есть руководство пользователя, к некоторым – руководство администратора, руководство системного программиста, а также море маркетинговых материалов и т.д. и т.п. Причём каждый из документов в нескольких форматах – для веб-справки, для публикации на сайте, для печати, для просмотра на экране… Как справиться со всей этой горой контента и выстроить работу максимально эффективно, советует Джекки Сэмюэлс.


Люди тратят сумасшедшее количество времени на попытки создать, найти, распространить, обновить и ещё что-либо сделать со своим контентом. Ковыряются в электронной почте, ищут в папках, лазят по ресурсам локальной сети… Быстро ли вы находите информацию? Ту ли информацию ищете, которая вам нужна? Уверены ли, что она актуальна и не содержит ошибок? Если она больше не соответствует действительности, вы узнаете об этом? Читать дальше…



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

06.03.2015

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


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

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



Порталы доставки контента: Будущее модульного контента

27.02.2015

00Как будет поступать контент к пользователю в будущем? Кроме того, как можно лучше учесть интересы отдельной целевой группы? Специальные порталы с умными настройками поиска обещают решить эту задачу. Так что уже стало реальностью и что станет? На эти и другие вопросы отвечают профессора из Германии, университетские преподаватели в сфере коммуникаций и контента Dr. Heiko Beier и Dr. Wolfgang Ziegler.


Создание и управление модульной информацией стало в последние годы предметом широкого обсуждения в области технических коммуникаций. [1]. Это привело к широкому применению компонентных систем управления содержимым (Component Content Management Systems, CCMS), модульное создание контента становится инструментом многих технических писателей, а кроссмедийная публикация [прим. пер.: размещение идентичных материалов одновременно в печатных и онлайновых СМИ] становится технической нормой. Однако во многих случаях не изменяется способ, с помощью которого планируется, создаётся и организуется доступ к информации. В этом плане традиционный ракурс основанной на документах информации часто остаётся в силе. Читать дальше…