Хочу поднять один вопрос: как ведёте оффлайн пользовательскую документацию для

Question

Хочу поднять один вопрос: как ведёте оффлайн пользовательскую документацию для

приложения?

Например у нас это построено, грубо говоря, так:
Есть один большой вордовский документ, где подробно расписано как пользоваться приложением.
Его делят на части, конвертируют в html, потом компилируют в qt-шный формат справки (qch). С самим приложением в комплекте идет qt-assistant, который это всё дело открывает.

В общем, не очень удобно.
Может кто поделиться своим подходом?

#c++ #embedded #programming #russian

0

01.05.2021

6 ответов

12 просмотров

Пашечка Автор вопроса

Pavel Zhigulin
У нас есть техписы :) Они по требованиям строчат п...

Ну, у нас тоже, вопрос именно в технической реализации, как это крепится к приложению?

0

01.05.2021

Pavel Zhigulin

Пашечка
Ну, у нас тоже, вопрос именно в технической реализ...

В нашем случае схема примерно как у вас, только сама документация ведётся в Confluence вроде.

0

01.05.2021

Евгений Пройдаков

Как вариант можно попробовать структурировпнный текстовый формат по типу MARKDOWN хранить в коде рядом с приложением, библиотеками и другими сущностями, при желании это можно смотреть через Web, ну и проблем с конвертировать в pdf etc я не вижу - формат простой, хотя сам такого не делал.

0

01.05.2021

Пашечка Автор вопроса

Евгений Пройдаков
Как вариант можно попробовать структурировпнный те...

Храните в репе с кодами - плохо. Технические писатели не должны иметь туда доступ)

0

01.05.2021

Stas Koynov

Пашечка
Храните в репе с кодами - плохо. Технические писат...

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

0

01.05.2021