FAQ блога: что, как и почему?

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

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

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

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

Что здесь будет?

Все о технологии единого источника в технической документации:

  • cтатьи;
  • how-tos;
  • FAQ;
  • различные кейсы внедрений

…и другие полезные материалы. Обмен опытом предполагается на одноименном форуме.

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

  • Начинающие технические писатели почерпнут здесь знания о ТЕИ, ее плюсах и минусах. Также будут размещаться краткие Tutorial и How-To.
  • Технические писатели со стажем найдут здесь сравнение различных технологий и применение их в различных ситуациях. Также будут рассмотрены вопросы автоматизации создания документов.
  • Для тимлидов, руководителей отделов разработки и СТО будут рассмотрены экономические аспекты использования единого источника. После прочтения материалов будет сразу понятно, имеет ли смысл внедрение в конкретной ситуации и какие выгоды от этого ждать.

Какие технологии единого источника будут рассмотрены?

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

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

Стандарты, либо официальные, либо имеющие все признаки таковых (т.е. обязательно наличие спецификаций, версионности, Technical Committee, и т.п.).

Здесь не предполагается обсуждение продуктов, имеющих признаки single-sourcing, но, по мнению автора, не являющимися таковыми: Help&Manual, MadCap Flare? AuthorIT и прочее.

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

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

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

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

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

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

Конечно!

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

  • вопросы о технологиях - см. выше;
  • собственные наблюдения и решения “как сделать что-то”.

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

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

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

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

Существует два варианты:

  1. Вы можете написать комментарии под любым постом. Для этого вам надо завести аккаунт на сервисе комментариев Disqus.
  2. Вы можете исользовать соответствующий раздел форума. В конце каждой статьи есть прямая ссылка на соответствующий топик.

Обратите внимание:

Disqus является наиболее удобным средством для комментирования, но это внешний сервис. А значит, всегда существуют риски его блокировки.

Возможность комментирования на форуме сделано специально для нивелирования рисков.

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

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

  1. Проверьте, что письмо от форума отсутствует в папке “Спам” в вашем почтовом клиенте.
  2. Прочтите топик форума
  3. Если все равно не удалось зарегистрироваться, то напишите на форум сюда. Этот топик не требует регистрации.

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

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

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

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