Сообщение Re: пользовательская документация от 22.12.2025 13:00
Изменено 22.12.2025 13:10 bnk
Re: пользовательская документация
Здравствуйте, swame, Вы писали:
S>Здравствуйте.
S>А в чем сейчас принято хранить и разрабатывать пользовательскую документацию?
S>Документация для большого программного комплекса.
S>Нужно чтобы можно было выставлять документацию на WEB, генерить разные PDF документы по списку разделов.
S>Чтобы был легкий доступ к редактированию.
S>Открытый внутренний формат исходников.
S>Сейчас юзаем Help & Manual старую однопользовательскую версию.
S>Разработка на винде.
Если документация для поставляемого продукта: mkdocs (material, with-pdf). Собирается как часть продукта.
Чем хорошо: markdown, написание документации можно легко делегировать ИИ. Он может посмотреть как работает код и напишет доки.
Скриншоты или видосики пока не знаю как его научить делать, эту часть приходится делать вручную.
Если продукт для компании, использовал DevOps (Wiki) как правило. Из плюсов что можно редактировать вживую и добавлять комментарии.
Его так же можно зачекаутить как GIT репозиторий, и делегировать написание документации ИИ.
Но вообще зависит что у заказчика есть. Confluence например туда же.
S>Здравствуйте.
S>А в чем сейчас принято хранить и разрабатывать пользовательскую документацию?
S>Документация для большого программного комплекса.
S>Нужно чтобы можно было выставлять документацию на WEB, генерить разные PDF документы по списку разделов.
S>Чтобы был легкий доступ к редактированию.
S>Открытый внутренний формат исходников.
S>Сейчас юзаем Help & Manual старую однопользовательскую версию.
S>Разработка на винде.
Если документация для поставляемого продукта: mkdocs (material, with-pdf). Собирается как часть продукта.
Чем хорошо: markdown, написание документации можно легко делегировать ИИ. Он может посмотреть как работает код и напишет доки.
Скриншоты или видосики пока не знаю как его научить делать, эту часть приходится делать вручную.
Если продукт для компании, использовал DevOps (Wiki) как правило. Из плюсов что можно редактировать вживую и добавлять комментарии.
Его так же можно зачекаутить как GIT репозиторий, и делегировать написание документации ИИ.
Но вообще зависит что у заказчика есть. Confluence например туда же.
Re: пользовательская документация
Здравствуйте, swame, Вы писали:
S>Здравствуйте.
S>А в чем сейчас принято хранить и разрабатывать пользовательскую документацию?
S>Документация для большого программного комплекса.
S>Нужно чтобы можно было выставлять документацию на WEB, генерить разные PDF документы по списку разделов.
S>Чтобы был легкий доступ к редактированию.
S>Открытый внутренний формат исходников.
S>Сейчас юзаем Help & Manual старую однопользовательскую версию.
S>Разработка на винде.
Если документация для поставляемого продукта: mkdocs (material, with-pdf). Собирается как часть продукта.
Чем хорошо: markdown, простой как палка. написание документации можно легко делегировать ИИ. Он может посмотреть как работает код и напишет доки.
Скриншоты или видосики пока не знаю как его научить делать, эту часть приходится делать вручную.
Если продукт для компании, использовал DevOps (Wiki) как правило. Из плюсов что можно редактировать вживую и добавлять комментарии.
Его так же можно зачекаутить как GIT репозиторий, и делегировать написание документации ИИ.
Но вообще зависит что у заказчика есть. Confluence например туда же.
S>Здравствуйте.
S>А в чем сейчас принято хранить и разрабатывать пользовательскую документацию?
S>Документация для большого программного комплекса.
S>Нужно чтобы можно было выставлять документацию на WEB, генерить разные PDF документы по списку разделов.
S>Чтобы был легкий доступ к редактированию.
S>Открытый внутренний формат исходников.
S>Сейчас юзаем Help & Manual старую однопользовательскую версию.
S>Разработка на винде.
Если документация для поставляемого продукта: mkdocs (material, with-pdf). Собирается как часть продукта.
Чем хорошо: markdown, простой как палка. написание документации можно легко делегировать ИИ. Он может посмотреть как работает код и напишет доки.
Скриншоты или видосики пока не знаю как его научить делать, эту часть приходится делать вручную.
Если продукт для компании, использовал DevOps (Wiki) как правило. Из плюсов что можно редактировать вживую и добавлять комментарии.
Его так же можно зачекаутить как GIT репозиторий, и делегировать написание документации ИИ.
Но вообще зависит что у заказчика есть. Confluence например туда же.