Угу

Возможно есть что-то типа <--exclude Rule#RuleName--> около ворнинга но я в эту сторону не смотрел, маркдаунлинт так умеет, не знаю, умеет ли Vale . Per project точно можно, а вот per file/per sentence не знаю

о! это посмотрю
мне может пригодиться

Всем привет!
Спасибо всем кто откликнулся на предложение рассказать о своих системах документирования #usedoc. Очень познавательно!

сейчас плотно на Sphinx+RST+plantuml+vale+openapi 3+redoc и chai для апи, в следующем году для нового проекта будем пробовать md+hugo+gitlab pages

@Lananovikova

Slate, GitLab, Confluence, Atom

Sergey

confluence + markdown (docusaurus, gitlab, atom, sublime text, intellij idea etc)

@jabba_jedi

Техрайтер, использую MadCap Flare + GitLab + SharePoint. Еще использую Confluence, Teams (wiki). Иногда Word с настроенными стилями.

Ivan Cheban

Tool: Sphinx
Format: RST
Linter: vale
VC: git

@stillru

Мы сейчас на Jekyll+md+vale+mermaid+mercurial
Ещё добавлю, вдруг пригодится:
Оптимизация изображений: image_optim
Валидация ссылок: htmlproofer

@arvikon

Пользовательская документация
— Sphinx, reST, линтеры doc8, Sphinx+linkcheck, vale
— Jekyll, Md
— Swagger, redoc
— CI: Jenkins, работал ещё с Gitlab CI, немного Travis
— поиск у нас кастомный
— аналитика Google Analytics, фидбек в Typeform

Внутренняя документация
— Confluence, sphinxcontrib-confluencebuilder
— аналитика Matomo
— на своих проектах пробовал Hugo

@Nick_Volynkin

Продолжу про инструменты:
Внутренняя документация

- MkDocs (md) с расширениями, Confluence, Swagger
- CI/CD: drone, docker
- bitbucket
- Google Analytics
Пользовательская документация
- Confluence, ScreenSteps, в Word через gostdown
- Яндекс.Метрика

Хочется добавить линтеры и в дальнейшем попробовать Hugo

@denmazin

У нас используется sphinx-doc&RST, локализация через gettext и sphinx-intl, система контроля версий GitLab, билд и деплой Docker&Jenkins, веб-сервер nginx
в планах описание REST API из OpenAPI 3.0 через redoc, линтер

@exebeeche

Интересно, и никто asciidoc ((

все: мардаун фу, нету стандарта
тоже все: сидят на маркдауне

Стандарт — ничто, экосистема тулзов — всё

есть! 🙋‍♀️

это да, вот как раз asciidoc — внтури, маркдаун — снаружи

кстати, для любителей asciidoc, наконец произошло счастье: https://github.com/asciidoctor/asciidoctor/pull/3539 и https://github.com/asciidoctor/asciidoctor/pull/3532

пусть, PR, но этим уже можно пользоваться

Коллеги, а кто-нибудь работает в связке MD под гитом с публикацией на SharePoint?

Взял на карандаш

also l18n and k8s

что люди делают с освободившимся временем

Американский инвестфонд Andreessen Horowitz неофициально называет себя a16z

Всё не так просто с k8s, там произношение соответствует сокращению, kubern-eight-s

И в режиме зануды, l10n, но i18n
Localisation
Internationalisation

d👌er