12.07.2024
docs-as-code
В целом — про написание документации в plain text с разметкой, с использованием всякого прочего полезного инструментария, придуманного для кода и окрестностей. В том числе линтеры для текста, git или другие системы управления версиями, системы сборки, генераторы статических сайтов и что там еще…
- https://t.me/docops - про документацию, технические коммуникации, техномаркетинг и управление знаниями.
- https://t.me/docsascode - их же чат
- https://t.me/asciidoctor - любители AsciiDoctor.
- static site generators (и эта тема тоже интересовала меня задолго до осознания себя техрайтером).
- https://t.me/technicalwriters/91259 - тут старт очередного разговора о генераторах статических сайтов с перечислением того, что людям заходило. Знакомые мне Nikola и jekyll тоже упомянуты были.
- https://www.sphinx-doc.org/en/master/usage/markdown.html
- https://foliant-docs.github.io/docs/
- https://t.me/foliantdocs - про Фолиант,
- https://docs.antora.org/antora/latest/ - Antora.
- https://squidfunk.github.io/mkdocs-material/
- https://docusaurus.io/ - ssg на React, доки пишутся на Markdown. Умеет всё, что и все, но ещё поддерживает MDX и React-комоненты (https://docusaurus.io/docs/markdown-features/react). Если дружите с React, можно делать классные интерактивные штуки в документах.
- https://t.me/technicalwriters/91259 - тут старт очередного разговора о генераторах статических сайтов с перечислением того, что людям заходило. Знакомые мне Nikola и jekyll тоже упомянуты были.
- https://github.com/aureliojargas/clitest – там есть занятная тема про testable documentation.
- https://habr.com/ru/articles/765136/ - маркдаун в pdf при помощи python, https://github.com/vb64/markdown-pdf/, способ основан на использовании библиотек markdown-it-py (md -> html) и PyMuPDF (html -> pdf).
- https://habr.com/ru/companies/yandex/articles/765768/ - яндеховый чел рассказывает про диплодок и yfm. https://diplodoc.com/
- языки разметки, в том числе маркдаун.
- https://habr.com/ru/companies/plesk/articles/555110/ - хабрастатья про docs-as-code. Комменты в чем-то занятнее, тот же заход на тему автопроверки «гниющей» документации.
- https://github.com/RabotaRu/DocHub - тут занятное про архитектуру как код.
- https://habr.com/ru/companies/youla/articles/537876/ разберём получение спецификации Swagger напрямую из комментариев к коду API.
Все посты