Единый источник
Внешний вид
Единый источник
Единый источник (либо технология единого источника) подход в разработке документации, когда из одного источника формируется (компилируется) более одного формата, например, HTML и PDF.
Примером работы в концепции «единого источника» может считаться связка[1]:
- программа-редактор текста. Редактирование осуществляется с использованием простых языков разметки (Markdown, reStructuredText или AsciiDoc) либо WYSIWYG-редактором для языка типа XML (Oxygen XML Editor, XMLMind, Syntext Serna)
- формат представления может быть DITA, DocBook, S1000D, а также может применяться другое представление, например, Antora
- единый источник хранения информации (системы контроля версий типа GIT или СУБД). В GIT хранятся текстовые файлы, в которых и находится сам текст документации.
- инструмент сборки финального документа из исходного формата - SSG
Также имеются реализации на основе комплексных инструментов, объединяющих все компоненты, например Author-It, Madcap Flare.
См. также
[править]- Docs as code
- Технология «единого источника» анг. раздел Википедии
