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

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

Алгоритмы связывания и структурированное писательство

27.01.2017

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

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

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

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



Алгоритмы структурированного писательства в процессе публикации

17.11.2016

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


Всё структурированное писательство в конечном итоге должно быть опубликовано. Публикация структурированного контента — это преобразование его из домена, в котором оно было создано (домен объекта, домен документа или абстрактная часть домена носителя), в наиболее определённую часть спектра домена носителя: точки на бумаге или на экране.

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

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



Алгоритмы в структурированном писательстве: Обработка структурированного текста

07.04.2016

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

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


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

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



Алгоритмы: Отделение контента от форматирования

10.03.2016

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

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


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



Качество в структурированном писательстве

03.02.2016

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

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


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

Роботы, которые читают

Машины действительно всё лучше и лучше понимают человеческий язык. Подход, который называется Глубинным обучением, всё больше становится основной технологией для таких компаний как Facebook, Google и Baidu как для понимания языка, так и для распознавания речи. Читать дальше…



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

22.01.2016

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

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


До сих пор я говорил о трёх доменах, через которые проходит контент и в которых он может быть записан: домен носителя, домен документа и домен объекта. Но существует четвёртый домен, который внедряется в эту картину структурированного писательства: домен управления.

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



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

14.01.2016

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

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


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



Конкурс «Наука документирования-2016»

15.12.2015

01«ПроТекст» уже долгое время сотрудничает с различными российскими и зарубежными вузами, среди наших партнёров Московский институт электроники и математики НИУ ВШЭ, Новосибирский государственный технический университет, Белорусский государственный университет и другие.

В июне 2013 года мы начали вести корпоративный блог, в котором аккумулировали самые разные материалы, посвящённые вопросам технического документирования в РФ и за рубежом. Статьи в блоге создавались по результатам совместной работы с вузами, формировались из данных, полученных при разработке и обновлении нашего авторского учебного курса для технических писателей, при проведении исследований рынка документирования в России и на основе других источников. Сейчас наш блог является целой кладезью информации, полезной любому специалисту по документированию. Чтобы донести собранные нами знания до научных кругов, а также для более активного вовлечения учёной общественности в процесс развития документирования, компания «ПроТекст» объявляет конкурс для работников научной сферы и технических специалистов. В конкурсе могут принять участие студенты, аспиранты, сотрудники высших учебных заведений, а также научные работники и технические специалисты предприятий России и стран Таможенного союза. Читать дальше…



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

11.12.2015

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

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


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



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

04.12.2015

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

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


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