Я тоже думаю, что это формат поясниельных записок. Уж не знаю, каких именно. Зависит от ваших задач. Если для "органов", то, наверное, нужен ГОСТ.

А вообще, в вашем случае этот процесс можно сколько-то автоматизировать. Написать (или найти) простой скрипт для формирования статьи или её скелета на основе предоставленного YAML-файла. Звучит интересно, да и руками переписывать доку при обновлении продукта не надо будет — на стадии активной разработки это частый кейс.

А если ещё YAML-файлы с комментарями от разработчиков, так это вообще огроменное поле для автоматизации:
Брать YAML, формировать из него тот же .md и отправлять в движок для документации типа sphinx-doc или pandoc (умеют генерить PDF). И на выходе получить практически готовую документацию.

всем привет!
поделитесь, пожалуйста, своими способами (читай, метриками) оценивания читабельности статей в confluence. Интересует все, начиная от того, сколько человек посмотрело статью и на сколько в среднем задерживаются на тсранице, до оценивания степени читабельности статьи. Заранее благодарю каждого✨

конфиги в YAML популярны у разных девопс-инструментов, можно подсматривать решения в них

https://docs.gitlab.com/ee/ci/yaml/
https://docs.travis-ci.com/user/tutorial/
https://docs.docker.com/engine/reference/builder/
https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/#describing-a-kubernetes-object
https://docs.ansible.com/ansible/latest/user_guide/playbooks.html

У нас к конфлюенсу прикручено https://matomo.org/, это как гугл-аналитика, только на своём сервере.
Там видны просмотры страниц и активность.

Коллеги, привет.
Можете поделиться полезной информацией (или ссылкой на нее) по документированию Yaml?

Ищу технического писателя для одного проекта, удаленно. Нужно доработать документацию на ОС по стандарту iso 26512 на русском языке. В дальнейшем возможно ещё сотрудничество по другим проектам.

И ещё ищу специалиста по MadCap Flare для сотрудничества (консультрование по продукту), тоже удаленно.
Пишите в ЛС. #wanted_tw

у меня еще есть к вам вопрос: как вы организуете описание полей интерфейса в статьях в confluence? мы сейчас используем таблицы, но это как-то приелось + порой занимает много места на странице

Извините за нескромный вопрос, но номер исошного стандарта точно верно указан?

У меня есть две любимых практики.

Скриншот с подписью или словесным описанием. И после скриншота списком описание полей в формате Название (как есть) — описание.

Или

Скриншот с подписью. И далее пошаговыйй алгоритм заполнения каждого поля. В каждом описание поля, если требуется.

Примеры могу скинуть в личные сообщения, дабы не засорять чат)

у меня еще есть к вам вопрос: как вы организуете описание полей интерфейса в статьях в confluence? мы сейчас используем таблицы, но это как-то приелось + порой занимает много места на странице

Ну кто по разному, зависит от ситуаций. Вообще лучше конечно юзверю наглядно демонстрировать интерфейс, а в табличках можно давать описание.

Это информация от заказчика. Если честно, пока не проверяла

мой промах, я не совсем точно сформулировала вопрос
скриншот - это само собой, а хотелось бы примеров, как представить описание полей со скриншота)

Ответил в Л.С.