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

Публикации

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

14.01.2016

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

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


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



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

11.12.2015

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

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


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



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

04.12.2015

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

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


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



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

23.09.2015

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

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


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



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

13.08.2015

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

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


 

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

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

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

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



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

18.06.2015

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

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


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

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

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

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