Вот @koshatneg и @Lananovikova уже откликнулись. Ещё @myauchelo, @factorized, @lilimopps и @kvaleev. Любой из этих замечательных людей может интересно рассказать про документацию. :)
Конечно, есть и другие, этих я вспомнил за первую минуту.

Спасибо за контакты!

пишите в личку, подробнее обсудим

Коллеги, только было интересное выступление на API The Docs об использовании code snippets (блоки кода) в документации. Докладчица вставляет куски кода в маркдаун-файлы с помощью плагина embed, которые указывают на исходный файл с кодом. Таким образом достигается актуальность кода в документации. Кроме того, она запускает unit tests в CI/CD для проверки правильности кода при билде документации. В качестве генератора использует Gatsby. Видео выложат позже, но я сделал запись:
https://youtu.be/px9LKhabUpk

ага, это то, о чём я недавно рассказывал. Мы такое сделали и внедрили, причем мы и json ответы сверяем с результатом

т.е. куски кода в документации прогоняются в тестах

Там всё немного проще, чем у вас ))

Как думаешь скрины вставлять?

?

однозначно вставлять!

Коллеги, кто-нибудь использует XWiki для создания документации или онлайн-справки?
Если да, то подскажите плагины, которые используете.

А можете тыкнуть носом, где рассказывали? Я проспала, а мне такое очень надо :)

Добрый вечер, хочется попросить консультации у более опытных людей) Я работаю преподавателем и мне поручили подготовить курс по техническому писательству. Не могли бы вы оценить и может что-то подсказать по содержанию, темам практических работ? Вот ссылочка на практики: https://app.gitbook.com/@ngieu/s/tehnicheskoe-pisatelstvo/

на пятое занятие сразу создать документацию для программного продукта - звучит хардкорно

Ну, то как они себе это представляют. Понятно, что не выдадут сразу все полностью и отлично

Спасибо за замечание)

Здесь немного хвастался.


Давайте я сделаю пост у нас об этом подходе и выложу сюда.

Супер, спасибо 🙏

Привет однофамилице!

Сорри за оффтоп :|