TGViewer
DocOps DocOps @docops · 4.27K subscribers
Post #89 979
Публикация из AsciiDoc в PDF по ГОСТ

Компания Course сдаёт отчётную документацию в PDF со строгими требованиями к оформлению, потому что работает с банками и государственными заказчиками. При этом:

— Документацию разрабатывают в формате разметки AsciiDoc, со всеми преимуществами подхода «документация как код»: пишут в удобном редакторе, версионируют в Git, легко объединяют изменения от нескольких авторов. (Попробуйте-ка заняться этим в Word.)

— Большáя часть документации автоматически генерируется из программного кода: структура БД, описание REST API сервисов, частично ПМИ и результаты автоматизированного тестирования по ПМИ.

Как получилось совместить ГОСТ и документацию как код? Николай Поташников, автор той самой статьи про диаграммы как код в PlantUML, разработал шаблон для публикации из AsciiDoc в PDF со всеми требованиями к оформлению.

Вот исходный код и документация к шаблону: github.com/CourseOrchestra/course-doc

Николай хочет дорабатывать и улучшать этот шаблон, чтобы и другие компании могли отказаться от неудобных редакторов в пользу AsciiDoc. Нужна обратная связь. Если вы используете AsciiDoc — пожалуйста, протестируйте шаблон и напишите о результатах в чат @docsascode, либо автору на @nmpotashnikoff или nm@potashnikoff.net.

#docops_toolkit #docops_markups #docops_gost
More from @docops
  1. Nov 12, 2024Чему я научился: софт-скиллы, пост 2/N. Прошел первый модуль курса по софт-скиллам и у мен…
  2. Nov 5, 2024Встретил замечательную фразу. Человек спрашивает, можно ли использовать OneDrive в качеств…
  3. Sep 26, 2024Чему я научился: софт-скиллы, пост 1/N. Есть такое довольно универсальное правило: чтобы ч…
  4. Sep 26, 2024Чему я научился в этом году Год выдался очень насыщенным: я делал совершенно новые для мен…
  5. Aug 19, 2024Как я выгорел У меня долгое время было ощущение, что надо сжать булки, ещё немного поработ…
  6. Jun 26, 2024Ну и где бездушная машина неправа?
Threads Profile ViewerView any public Threads profile without an account.Open ThreadLook →Writing with AI? Make it sound human.Metric37 rewrites AI drafts so they read naturally. Free AI detector, 1,500 words free.Try Metric37 →