Любые советы о том, как изучить DITA для технического письма?

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

DITA — это и конкретная структура, и подход. Моя группа документации в настоящее время работает над книгой DITA Best Practices: A Roadmap for Writing, Editing and Architecting in DITA , написанной Лаурой Беллами, Мишель Кэри и Дженифер Шлотфельдт, и пока что мы находим ее хорошим введением. Мы не планируем переходить на платформу DITA , но мы пытались применить аналогичный подход самостоятельно, и мы находим книгу полезной для указания на проблемы, о которых мы недостаточно думали. Книга также содержит много информации, относящейся к фреймворку, поэтому она должна быть еще более полезной для тех, кто полностью использует DITA.

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

Я не знаю, будет ли это слишком поздно, но тем не менее, вот бесплатный инструмент, который я нашел для изучения DITA:

http://www.learningdita.com/

В настоящее время я слежу за курсом, хотя он немного снизил мои задачи. Я уже знаком с большей частью содержания из собственного чтения, и с этой точки зрения я скажу, что оно очень всеобъемлющее и тщательное.

Хотя у меня уже есть основные идеи, которые я бы порекомендовал новичкам, все начинается с простого.

Вот полное руководство по стилю, в котором подробно объясняется, как использовать каждый элемент, если вы погружаетесь и пробуете его:

https://www.oxygenxml.com/dita/styleguide/webhelp-feedback/index.html

Для более практического ознакомления вы можете загрузить и установить DITA Open Toolkit . После того, как вы настроите инструментарий, вы сможете:

1. Взгляните на источник DITA XML для настоящей публикации, а именно руководства пользователя DITA Open Toolkit. Исходник находится в папке docsrc, но вы также можете получить к нему доступ на GitHub .
2. Используйте этот источник для создания окончательного вывода, например, HTML или PDF. Чтобы сделать это, см. раздел Восстановление документации DITA-OT (или главу 20 в версии PDF).
3. Откройте файл темы .dita. Попробуйте найти эту тему в документе, выполнив поиск по ее названию. Обратите внимание на то, как XML следует структуре определенной темы . В DITA тема является основной единицей авторской разработки .
4. Откройте файл .ditamap и сравните то, что вы видите, с оглавлением в этой публикации. Обратите внимание, как он использует элементы карты DITA для организации ряда тем.
5. Внесите небольшое изменение в название темы (возможно, предварительно сделав резервную копию) и пересоберите публикацию. Обратите внимание, как ваши изменения переносятся в новую версию документа.
6. К этому моменту вы поймете, что написать документ в DITA без какой-либо дополнительной поддержки инструментов может быть довольно сложно. Именно здесь на помощь при редактировании приходят инструменты, поддерживающие DITA, такие как Oxygen XML Author . Обратите внимание, что Oxygen поставляется в комплекте с DITA Open Toolkit. На dita-ot.org есть список инструментов, которые используют DITA Open Toolkit . См. также этот список программных инструментов, связанных с DITA .

Раздел 2.2.1.2 стандарта Darwin Information Typing Architecture (DITA) Oasis содержит дополнительные сведения о преимуществах тематической авторской разработки.

Дополнительные примеры авторской разработки на основе DITA см. в списке коллекций DITA с открытым исходным кодом на сайте oasis-open.org.