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

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

Адаптация документов к требованиям ГОСТ с помощью MadCap Flare 12

09.11.2016

coverОформить документ по ГОСТ автоматически? В MadCap Flare — легко! Представляем вашему вниманию статью Павла Сапожникова, профессионального технического писателя, активно использующего в своей работе современные технологии документирования. Данная статья посвящена оформлению комплектов документов по российским стандартам в MadCap Flare, при этом изложенные в ней рекомендации могут по аналогии применяться и в других современных профессиональных инструментах для документирования.

У Вас ещё нет этого полезного софта? Не хотите долго возиться с документами, а потом мучиться с приёмкой в госкомиссии? Поможем Вам разработать комплекты документации по ГОСТ на аутсорсе. Обращайтесь! 🙂

Большинство софтверных компаний российского IT-рынка придерживаются собственного корпоративного стиля оформления документации на разрабатываемые программные продукты. Кажется, что строгие конструкторские рамки, шрифт Times New Roman, и прочие требования ГОСТ уже давно канули в лету. Да и у современного пользователя вид User Guide, оформленного по всем канонам ГОСТ19 и ГОСТ34, вызовет разве что недоумение.

Тем не менее, российский IT-рынок специфичен и местами консервативен. Здесь до сих пор встречается требовательный заказчик в лице государственных структур, для которого приходится соблюдать некоторые нормы ГОСТ. Читать дальше…



ТехДок 2014: Единый источник

05.12.2014

LOGO techdoc2014_single sourceСтавшая уже привычной, конференция для технических писателей ТехДок прошла 27 ноября 2014 года. Тема события – технология единого источника в документировании. Тема не простая и пока не сильно распространённая в России и странах ближнего зарубежья, но, тем не менее, важная и интересная.

На конференции было рассказано о технологии, рассмотрен вопрос использования в России и в других странах, сделан обзор стандартов и программного обеспечения для работы с единым источником. Докладчики поделились своим опытом внедрения и использования технологии, рассказали о её плюсах и минусах. Мы узнали особенности стандарта S1000D и много простых, но полезных советов о том, как повысить эффективность процесса разработки документации. Огромное спасибо всем докладчикам!

И спасибо пришедшим слушателям! Мы надеемся, что вы провели время с удовольствием и с пользой для профессионального роста. Максимальное одновременное количество слушателей – 78 человек, а среднее количество онлайн – 70-75 человек, что подтверждает актуальность темы.

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

Для всех, кто интересуется технологией единого источника, мы публикуем записи и презентации конференции. Итак, «ТехДок 2014: Единый источник»: Читать дальше…



OASIS утверждает стандарт обмена локализуемыми данными и сопутствующей информацией XLIFF 2.0

24.11.2014

24.11.14Возвращаемся к одному из самых востребованный на данный момент направлений – локализации. Для тех, кто занимается или планирует заниматься локализацией на профессиональной основе, у нас хорошие новости – в августе этого года была утверждена новая версия стандарта, который позволит вам сэкономить много сил и средств.


IBM, Microsoft, Oracle, SDL, Symantec, научно-исследовательский центр локализации университета Лимерика и другие повышают совместимость между коммерческими и открытыми инструментами локализации.

Консорциум OASIS по международным открытым стандартам объявил об утверждении XML стандарта обмена локализируемыми данными и сопутствующей информацией XLIFF 2.0. Делая возможным взаимодействие между инструментами локализации, XLIFF освобождает издателей от сложности и дороговизны предварительной обработки локализуемого контента из собственных форматов. XLIFF 2.0 стал официальным стандартом OASIS – статус, который означает высший уровень одобрения. Читать дальше…



Техническая документация: разбираемся в спецификациях S1000D и DITA

27.10.2014

27.10.14В своих публикациях мы уделяли большое внимание архитектуре DITA, но хотелось бы отметить, что это не единственный полноценный стандарт для создания технической документации. Технический консультант и специалист по разработке структурированной документации Себастьен Клима рассказывает об основных преимуществах разных спецификаций.


 

Спецификация S1000D

S1000D – это спецификация для производства технической документации, связанной с эксплуатацией (ТОиР – Техническое обслуживание и ремонт), основанная на концепции модулей данных и хранящаяся в общей базе данных эксплуатационной документации (ОБДЭ). Эта спецификация полностью отвечает требованиям технического обслуживания для всех видов воздушных, наземных и водных механизмов, которые содержат большое число компонентов. Таким образом, спецификация S1000D позволяет организовывать информацию в модульной форме, повторно использовать модули данных, избегать дублирования информации, что подразумевает значительную экономию денежных и временных затрат при создании и управлении публикациями. Читать дальше…



Кто переходит на DITA, а кому не надо и пытаться?

14.05.2014

14.05.14Ещё раз поговорим о DITA. Формат набирает всё большую популярность и, думаем, некоторые из вас уже задумались о переходе на DITA. Давайте попробуем разобраться, стоит ли это делать именно в вашем случае.


«Обещания» системы DITA сделать контент более структурированным и простым для публикации обращены к огромному количеству компаний, которые работают с огромным количеством технического контента. На данный момент на DITA переходят очень многие предприятия, где работают от одного техписа до компаний более чем 500 штатными писателями. Так подойдёт ли DITA вашей организации, и как понять, что она вам не подходит?

Кто переходит на DITA?

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



Измените подход к написанию контента: альтернативы DITA (часть 2)

11.04.2014

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


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

SPFE: Разработка Марка Бейкера SPFE (Synthesis, Presentation, Formatting, and Encoding – Синтез, Презентация, Форматирование и Кодировка) является запросоориентированным структурированным авторским подходом, который многообещающе выглядит, но пока не имеет ни широкого распространения, ни поддержки. SPFE (или «spiffy», как называют его в англоговорящих странах) представляет собой архитектуру для построения структурированного авторинга и издательских систем, который использует функции базы данных XML в обход необходимости внедрения дорогого CCMS.

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



Измените подход к написанию контента: альтернативы DITA (часть 1)

09.04.2014

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


Когда вы и ваша команда, и даже ваш босс придёте к выводу, что «должен быть лучший способ» писать технический контент, ваши поиски, скорее всего, приведут к DITA (Дарвиновская Архитектура Типизированной Информации) как альтернативе ночным кошмарам обработки, копипасты, форматирования и поддержки версий в Word, с которым вы так долго работали. Но, прежде чем запрыгнуть в автобус с конечной станцией «DITA: Земля обетованная», помните, что существуют жизнеспособные альтернативы DITA, которые могут даже лучше удовлетворять вашим потребностям.

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