Зачем мне нужна DITA? (часть 1) | Разработка технической документации

Опубликовано: 10.10.2018

видео Зачем мне нужна DITA? (часть 1) | Разработка технической документации

BALDI'S В РЕАЛЬНОЙ ЖИЗНИ! БАЛДИ МОЙ РЕПЕТИТОР! Baldi Basics in real life, funny video 🤣

Зачем мне нужна DITA? (часть 1)

Мы снова вернулись к одной из самых обсуждаемых тем нашего блога – DITA и важность её внедрения. Давайте ещё раз вспомним все преимущества этого стандарта.


ДЕТИ ЛЕДИБАГ И СУПЕР-КОТА 😱 Сказки на ночь от Маринетт Miraculous Ladybug & Cat Noir in real life

Дарвиновская Архитектура Типизированной Информации (DITA) является стандартом на базе XML, который используется в основном для технической и всё чаще и для других типов документации. Мы уже представляли вам статью «Что такое DITA и зачем нам это нужно?» . Мы подробно остановились на «что», а теперь хотели бы ещё раз подчеркнуть «зачем». И это вопрос, который вам нужно задать себе, если работа над созданием технического контента – часть вашей ежедневной работы.

Ответ обманчиво прост: Никуда от этого не денешься; если вы не применяете DITA как стандарт документации, вы работаете гораздо медленнее и менее эффективно, чем должны бы.

Требует ли внедрение DITA времени, усилий и знаний? Да, это так. И тогда вы сможете пожинать плоды в течение следующих… нуууу… в течение всего обозримого будущего.

DITA:

Экономит время Помогает поддерживать высокое качество и согласованность Повышает удобство работы с продуктом и документацией Открывает путь к огромному количеству параметров документации Экономит время

DITA экономит время

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

DITA отделяет содержание от форматирования, так что писатели пишут; они не форматируют. Форматирование происходит автоматически и последовательно как часть процесса публикации.

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

DITA повышает качество и согласованность

DITA даёт писателям четкую, повторяемую, но настраиваемую модель, по которой можно писать. Например, DITA требует, чтобы каждый топик имел название; пререквизиты для выполнения задачи всегда предшествуют задаче (и действиям по её выполнению); а результат задачи всегда следует за действиями.

С DITA у писателей есть достаточная структура, чтобы последовательно писать в соответствии с методическими указаниями; нужно говорить людям, что им нужно иметь или знать прежде, чем объяснять, как выполнить первое действие. Не редкость, когда в инструкции попадается действие, удивляющее читателя информацией, которую он должен был узнать, прежде чем начал решать задачу. Такого рода информация теперь всегда будет стоять до списка действий.

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

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

(продолжение следует)

Источник: Why Should I Care About DITA?

Тэги: DITA , XML , единый источник , качество контента , форматирование

Меню сайта
Новости
Реклама
Реклама
Реклама