Documentation is Dead, Long Live Documentation! На конференци | Shut up and write

Documentation is Dead, Long Live Documentation!

На конференции GitLab было 2 доклада про документацию:
- Use Gitlab to Deliver "Docs-as-Code" Technical Documentation, который очень похож на доклад этого же автора на Write the Docs Australia.
- Documentation is Dead, Long Live Documentation!, который меня зацепил, потому что я люблю слушать про опыт создания документации от не технических писателей. Тут 2 докладчика, менеджер и разработчик, которые рассказывают свои впечатления от создания документации в Confluence и переезде на другую систему документирования.

Чем не нравится Confluence

- 90% времени уходит на оформление документации, а не на создание текста
- слишком много возможностей, часть из которых не нужна
- не работает поиск

Чего хотят

- чтобы было легко писать и публиковать документацию
- был базовый набор возможностей (как вставка изображения и ссылки) и продвинутый (как вставка примеров кода)
- можно пользоваться с Web или IDE
- хороший поиск
- обратная связь прямо в процессе работы над документом

Команда понимала, что они могут это сделать и с помощью Confluence, но слишком сложно.

Что используют сейчас

Попробовали VuePress, но потом переехали Material for MkDocs. Документация хостится на GitLab Pages. Из дополнительных фичей интегрировали в MkDocs draw.io. Счастливы:)

Доклад можно посмотреть на Youtube, для тех кто пропустил.

#намвсемнужнапомощь