Вы хотите добавить changelog в доки для пользователей или для разработчиков?

Сейчас попробую объяснить

Есть сервисы, у сервисов есть документация для пользователей, документация встроена в сервисы. Но так как сервисы допиливаются и функционал меняется, то эти изменения нужно тоже отобразить в документации, чтобы юзер сервиса был уведомлён: "Эй парень, мы изменили тут кое что, теперь это работает так, а подробнее можешь почитать в этой главе документации". То есть по мимо актуальной документации, есть блок "как было" "как стало"

@sidigi_coder  А сервис это сайт или API?

@sidigi_coder если сайт, то можно сделать онбоардинг пользователей в интерфейсе. При первом заходе на экран, где появилась новая функциональность, явно о ней рассказываем. Вот про это хорошая статья. https://medium.com/sobaka/%D0%BE%D0%BD%D0%B1%D0%BE%D1%80%D0%B4%D0%B8%D0%BD%D0%B3-%D0%B2-%D0%BF%D1%80%D0%BE%D1%84%D0%B5%D1%81%D1%81%D0%B8%D0%BE%D0%BD%D0%B0%D0%BB%D1%8C%D0%BD%D1%8B%D1%85-%D0%B8%D0%BD%D1%82%D0%B5%D1%80%D1%84%D0%B5%D0%B9%D1%81%D0%B0%D1%85-e6a63a6da236

Если важен общий обзор, работает централизованный changelog. Например, мы его публикуем на сайте (https://docs.plesk.com/release-notes/onyx/change-log/), куски кладём в рассылки, и ещё шлём уведомления пользователям, которые заводили баги, починенные в этом релизе. Мол, мы починили баг XX-123 про то-то, который вы завели тогда-то. И из changelog-а можно давать ссылки в большую документацию.

спасибо почитаю, апи сервисы тоже есть - но они пока не критичны

@Nick_Volynkin у нас в компании последнее время появился какой-то бурный интерес с changelogам, поэтому я чувствую, что придется идти по пути, который Вы описали вторым (у нас пока нет рассылки) и возможно сменить формат логов, т.к. бизнес частично не понимает value апдейтов

@sidigi_coder как Вам vuepress? Годный инструмент?

Для быстрой генерации документации очень даже неплох. Там поддержка vue компонентов, но заполнять это может только продвинутй пользователь или разработчик. Вообще vuepress мне понравился больше всег генераторов, при желании можно сделать и разделение на права и доступы, для этого можно воспользоваться oauth2.0  То есть документацию можно разделить (но это надо допиливать напильником)

VuePress больше подходит для того для чего он создавался - для документации отдельного продукта. Для совокупной базы знаний он слабоват - там есть теги поиска, но нет полнотекстового поиска например

хотя я думаю что тот кто хорошо знает js запихнёт туда что угодно, ведь там также есть поддержка js прямо из коробки. То есть в маркдауне можно писать сразу js код

https://nova.laravel.com/docs/1.0/installation.html - вот отличный прмер документации

Как это по-фронтендерски! Следующий шаг — добавлять зависимости проекта прямо в маркдауне. Например, нужно нам многоточие поставить. Не искать же символ юникода, в самом деле. Лучше подключить библиотеку, в которой есть многоточие. :)))

Погибаю на винде без длинного тире, поставил бы пакет, чтоб его юзать. А тут какие-то штуки надо ставить чтобы жмакнуть тире

Ужс

раскладка Бирмана?

Вот ее надо, да

Скачана уже, но не решался пока

К сожалению да, не разделяю подход фронтенда, но тем не менее это даёт большие возможности по показу контента, разделения прав, ну и кучу node_modules - Мы этой фичей не пользовались - брали только маркдаун - даже без этого всего для быстрого наполнение контента он всё же хорош

Я на него наткнулся некоторое время назад и сейчас думаю, насколько он нам подходит, т.к. количество доков растет и gitbook уже не справляется.
У нас продукт частично пилится на Vue, поэтому такая интеграция была бы к месту.
Из последнего, что я видел, Vuepress мне тоже нравится больше остальных, особенно порадовала гибкость сайдбара и секции, которые можно делать в навбаре. Это очень не хватало.
Права - это интересно, тоже было бы интересно запилить. А насчёт поиска, да, она ищет только по заголовкам. Но, можно прикрутить algolia.

Я знаю js и для меня это просто killing feature