Re[2]: пользовательская документация
От: swame  
Дата: 27.12.25 12:53
Оценка:
Здравствуйте, bnk, Вы писали:

bnk>Здравствуйте, swame, Вы писали:


S>>Здравствуйте.

S>>А в чем сейчас принято хранить и разрабатывать пользовательскую документацию?
S>>Документация для большого программного комплекса.
S>>Нужно чтобы можно было выставлять документацию на WEB, генерить разные PDF документы по списку разделов.
S>>Чтобы был легкий доступ к редактированию.
S>>Открытый внутренний формат исходников.
S>>Сейчас юзаем Help & Manual старую однопользовательскую версию.
S>>Разработка на винде.

bnk>Если документация для поставляемого продукта: MkDocs (material, with-pdf). Собирается как часть продукта.

bnk>Чем хорошо: markdown, простой как палка. написание документации можно легко делегировать ИИ. Он может посмотреть как работает код и напишет доки.
bnk>Скриншоты или видосики пока не знаю как его научить делать, эту часть приходится делать вручную.

Да спасибо смотрю на это.
Но вот with-pdf как я понял из описания собирает всю базу в один документ, а надо как-то выборочно.

bnk>Пример MkDocs (Microsoft)

bnk>https://pnp.github.io/pnpjs/
bnk>https://pnp.github.io/sp-dev-fx-controls-react/

bnk>Если продукт для компании, использовал DevOps (Wiki) как правило. Из плюсов что можно редактировать вживую и добавлять комментарии.

bnk>Его так же можно зачекаутить как GIT репозиторий, и делегировать написание документации ИИ.
bnk>Но вообще зависит что у заказчика есть. Confluence например туда же.
 
Подождите ...
Wait...
Пока на собственное сообщение не было ответов, его можно удалить.