Единый источник в технической документации

Всё о принципе единого источника на русском

Menu

FAQ

Краткий FAQ по блогу

Цель этого ресурса

Предоставить русскоязычной аудитории полезную информацию по использованию принципа единого источника в технической документации в ИТ (и не только).

Основные причины создания ресурса

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

Что здесь будет? Почему и чем этот ресурс может быть мне полезен?

Технологии (принцип) единого источника в технической документации (статьи, How-To, FAQ, различные кейсы внедрений и другие полезные материалы). Обмен опытом предполагается на одноименном форуме.

Начинающие технические писатели найдут здесь сведения о технологии, ее плюсах и минусах. Также будут размещаться краткие Tutorial и How-To.

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

Для тимлидов, руководителей отделов разработки и СТО будут рассмотрены экономические аспекты использования единого источника. После прочтения материалов будет сразу понятно, имеет ли смысл внедрение и какие выгоды от этого ждать.

Какие именно технологии?

Только xml-based стандарты, направленные на кросс-платформенное использование (в основной массе Docbook/XML, а также DITA, TEI, MEI и другие языки семантической разметки).

Что означает "только xml-based стандарты"?

Стандарты, либо официальные, либо имеющие все признаки таковых (т.е. наличие спецификаций, версионности, Technical Committee, и т.п.). Т.е. здесь не предполагается обсуждение никаких Help&Manual, MadCap Flare и других подобных вещей c закрытими спецификациями, неясными перспективами и т.п.

Что включает в себя ресурс?

Ресурс делится на две части:

  1. Блог (там, где вы сейчас находитесь) - для того, чтобы почитать и научиться делать подобное у себя.

  2. Форум - для того, чтобы решить вопрос или поделиться решением с другими.

В блоге еще мало материала. Когда именно появится все то, о чем говорится выше?

Этот ресурс поддерживается на некоммерческой основе одним человеком в свободное время, поэтому наполнение будет идти постепенно.

Можно вам чем-то помочь?

Конечно!

Приветствуются:

Особо приветствуются репосты и линки на это ресурс на профильных ресурсах и форумах.

У меня вопрос, связанный с одной из технологий. Как мне его задать?

Используйте форум. Он специально предназначен для обмена опытом.

У меня вопрос по статьям этого блога. Как мне его задать? Я не вижу полей для комментирования.

К сожалению, движок блога поддерживает только внешние сервисы комментариев (например, Disqus), поэтому они отключены.

Однако, в конце каждой статьи есть ссылка на соответствующий раздел форума, где вы можете оставить свои комментарии, вопросы или поделиться опытом. Это сделано с несколькими целями:

Я был на форуме, но у меня не получилось зарегистрироваться...

Последовательность действий:

  1. Проверьте, что письмо от форума отсутствует в папке "Спам" в вашем почтовом клиенте.

  2. Прочтите топик

  3. Если все равно не удалось зарегистрироваться, то напишите сюда. Этот топик не требует регистрации.

Можно ли использовать размещенные здесь материалы в своих работах?

Для начала прочтите правила использования

Я не нашел ответа на свой вопрос. Как мне связаться с автором?

См. страницу Контакты

Написано Эдуард Тибет от Пятница Март 3, 2017

Постоянная ссылка -

Контакты »