В фолианте есть DBDoc, в принципе там никакой магии, можно состряпать что-то похожее и без фолианта:

Документация хранится внутри БД, у большинства вендоров есть механизмы для хранения описаний для таблиц, полей и т д. Как правило это называется "comment". Эти комменты можно вытаскивать из базы запросами. Собственно, DBDoc это и делает, вытаскивает из БД структуру таблиц и все описания запросами, потом отдаёт эти данные в шаблон, по которому генерируется дока.

Мы используем шаблонизатор jinja2, который очень гибкий и мощный. Если просто структуры таблиц и описания полей\таблиц не хватает, то можно писать дополнительный текст уже в foliant-проекте. Например, если нужно подробно расписать со схемами и картинками, зачем нужна эта таблица и в каких процессах участвует, то наверное не стоит это всё писать в комменте БД. Такое можно написать в отдельном файлике и той же jinja2 встроить его в шаблон.

В общем, схема довольно универсальная

спасибо ☺️

Пояснения к выпуску

Коллеги, а кто-нибудь затевал контекстные справки? На большой (очень большой) интерфейс - там вообще подъёмный объём работ?

какие там подводные грабли?

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

Да ладно, любой объем работ подъёмен, страшно лишь начать)

для начала можно написать контекст к основным окнам (настройки, например). потом добавлять

по окнам, потом по элементам? И соответственно структуру справочника перестроить?

почему? контекстная справка идет отдельно от  полной

т.е. она может входить в ту же книжку, но не отображаться в токе

и эти топики контекста будут открываться из продукта

с в качестве связки с полной справкой, где инструкции и все прочее можно в конце топика контекста давать ссыль, мол используйте это в таких-то задачах

так что имеющийся справочник у вас не должен пострадать

ух, удвоение поддерживаемых источников :( ну не удвоение, но будет большое дублирование и, возможно, без цитат атомарных текстов

вообще-то нет.

у контекстной и  полной справки разные цели

и поэтому дублирования инфы там быть не может

в контекстной вы описываете только контролы. дефолтные значения, связи с другими контролами, если есть.

никаких пояснений пространных, никаких инструкций.