Сообщение Re[2]: пользовательская документация от 27.12.2025 12:50
Изменено 27.12.2025 12:56 swame
Re[2]: пользовательская документация
Здравствуйте, Kernan, Вы писали:
K>Здравствуйте, swame, Вы писали:
S>>Здравствуйте.
S>>А в чем сейчас принято хранить и разрабатывать пользовательскую документацию?
K>В MS Office в режиме ревью работаешь над докой "по госту", потом в PDF перегоняешь, но надо следить чтобы все ссылки кликались и работали. Для интерактива можно сделать своего ИИ-агента и обучить.
Все это выглядит как шаг назад к бардаку даже по сравнению Help & Manual.
K>Почему вордовый документ? Там есть замечательный режим ревью и редактирование когда можно писать комментарии прямо в исходной доке во время ревью того, что напишет техпис.
Не особо актуально.
S>>Нужно чтобы можно было выставлять документацию на WEB, генерить разные PDF документы по списку разделов.
K>Не нужно. PDF качается на ПК и с него и смотрится.
Имелось в виду что один и тот же раздел из базы может переиспользоваться в разных томах документации в актуальном виде без ручного копирования.
S>>Чтобы был легкий доступ к редактированию.
K>Да, MS Office и грамотное версионирование продукта и доков.
S>>Открытый внутренний формат исходников.
K>Доки для пользака идут из сторей и фичей, а не из исходников.
Имелись в виду исходники документации, из которых собираются PDF и онлайн а не код программы.
S>>Разработка на винде.
K>Тогда вордовый док самое лучшее. Хранить можно на шаре чтобы был совместный доступ для ревью, например.
K>Здравствуйте, swame, Вы писали:
S>>Здравствуйте.
S>>А в чем сейчас принято хранить и разрабатывать пользовательскую документацию?
K>В MS Office в режиме ревью работаешь над докой "по госту", потом в PDF перегоняешь, но надо следить чтобы все ссылки кликались и работали. Для интерактива можно сделать своего ИИ-агента и обучить.
Все это выглядит как шаг назад к бардаку даже по сравнению Help & Manual.
K>Почему вордовый документ? Там есть замечательный режим ревью и редактирование когда можно писать комментарии прямо в исходной доке во время ревью того, что напишет техпис.
Не особо актуально.
S>>Нужно чтобы можно было выставлять документацию на WEB, генерить разные PDF документы по списку разделов.
K>Не нужно. PDF качается на ПК и с него и смотрится.
Имелось в виду что один и тот же раздел из базы может переиспользоваться в разных томах документации в актуальном виде без ручного копирования.
S>>Чтобы был легкий доступ к редактированию.
K>Да, MS Office и грамотное версионирование продукта и доков.
S>>Открытый внутренний формат исходников.
K>Доки для пользака идут из сторей и фичей, а не из исходников.
Имелись в виду исходники документации, из которых собираются PDF и онлайн а не код программы.
S>>Разработка на винде.
K>Тогда вордовый док самое лучшее. Хранить можно на шаре чтобы был совместный доступ для ревью, например.
Re[2]: пользовательская документация
Здравствуйте, Kernan, Вы писали:
K>Здравствуйте, swame, Вы писали:
S>>Здравствуйте.
S>>А в чем сейчас принято хранить и разрабатывать пользовательскую документацию?
K>В MS Office в режиме ревью работаешь над докой "по госту", потом в PDF перегоняешь, но надо следить чтобы все ссылки кликались и работали. Для интерактива можно сделать своего ИИ-агента и обучить.
Все это выглядит как шаг назад к бардаку даже по сравнению Help & Manual.
K>Почему вордовый документ? Там есть замечательный режим ревью и редактирование когда можно писать комментарии прямо в исходной доке во время ревью того, что напишет техпис.
Не особо актуально.
S>>Нужно чтобы можно было выставлять документацию на WEB, генерить разные PDF документы по списку разделов.
K>Не нужно. PDF качается на ПК и с него и смотрится.
Имелось в виду что один и тот же раздел из базы может переиспользоваться в разных томах документации в актуальном виде без ручного копирования.
S>>Чтобы был легкий доступ к редактированию.
K>Да, MS Office и грамотное версионирование продукта и доков.
S>>Открытый внутренний формат исходников.
K>Доки для пользака идут из сторей и фичей, а не из исходников.
Имелись в виду исходники документации, из которых собираются PDF и онлайн а не код программы.
S>>Разработка на винде.
K>Тогда вордовый док самое лучшее. Хранить можно на шаре чтобы был совместный доступ для ревью, например.
Помню писал диссер страниц всего на 500 в ворде в одиночку, даже это было довольно адово.
K>Здравствуйте, swame, Вы писали:
S>>Здравствуйте.
S>>А в чем сейчас принято хранить и разрабатывать пользовательскую документацию?
K>В MS Office в режиме ревью работаешь над докой "по госту", потом в PDF перегоняешь, но надо следить чтобы все ссылки кликались и работали. Для интерактива можно сделать своего ИИ-агента и обучить.
Все это выглядит как шаг назад к бардаку даже по сравнению Help & Manual.
K>Почему вордовый документ? Там есть замечательный режим ревью и редактирование когда можно писать комментарии прямо в исходной доке во время ревью того, что напишет техпис.
Не особо актуально.
S>>Нужно чтобы можно было выставлять документацию на WEB, генерить разные PDF документы по списку разделов.
K>Не нужно. PDF качается на ПК и с него и смотрится.
Имелось в виду что один и тот же раздел из базы может переиспользоваться в разных томах документации в актуальном виде без ручного копирования.
S>>Чтобы был легкий доступ к редактированию.
K>Да, MS Office и грамотное версионирование продукта и доков.
S>>Открытый внутренний формат исходников.
K>Доки для пользака идут из сторей и фичей, а не из исходников.
Имелись в виду исходники документации, из которых собираются PDF и онлайн а не код программы.
S>>Разработка на винде.
K>Тогда вордовый док самое лучшее. Хранить можно на шаре чтобы был совместный доступ для ревью, например.
Помню писал диссер страниц всего на 500 в ворде в одиночку, даже это было довольно адово.