Docs as code
Docs as code - концепция подготовки документации наравне с программным кодом. Она не исключает использования визуальных (WYSWYG)-решений. Т.е. визуально подготовка документации может не отличаться от работы в Google Docs например. Сам текст документации размечен с помощью языков разметки Markdown, reStructuredText или AsciiDoc. Либо других иных (непринципиально). Концепция Docs as code подразумевает применение другой концеgции - Единый источник.
Критерии Docs as code
[править]Как критерии концепции описываются следующие моменты[1]:
- Использование тикет-системы для работы с документацией
- Хранение текстов документации в системе контроля версий (например, в Git)
- Человекопонятная разметка текста, а не не XML/SGML
- Markdown,
- reStructuredText,
- AsciiDoc
- Code Reviews
- Automated Tests
SSG-решения
[править]Концепция Docs as code реализована в решениях ля подготовки документации, которые относятся к категории "SSG" (Static site generator). В результате их работы появляются неизменяемые файлы. А сам процесс поход на компиляцию программы из исходного кода.