Программное обеспечение для создания и ведения руководств пользователя/обслуживания

Мы ищем программное обеспечение, которое позволит нам легко создавать и поддерживать руководства по обслуживанию для машин, которые мы производим. У нас есть около 25 машин, и до сих пор мы использовали Microsoft Word, но чрезвычайно сложно и требует много времени поддерживать 25 руководств по обслуживанию, которые содержат как минимум 75% текста и изображений. Когда мы вносим изменения в один, мы должны открыть остальные 24 и внести такое же изменение.

Нам нужно что-то, что позволит нам использовать какой-то «общий» текст и изображения, которые вставляются в заполнители в руководствах, чтобы мы могли изменить этот общий источник, и он будет обновляться для всех руководств, не искажая формат. Номера страниц и индекс также должны автоматически обновляться.

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

Windows — предпочтительная платформа, но я открыт и для других.

Должен ли результирующий документ быть в формате Word – или вам подойдет и другой формат, например PDF? Копируются ли «общие части» без каких-либо корректировок (кроме, возможно, автоматически сгенерированных номеров глав и сносок)? Вас устроит другой формат ввода, такой как Markdown или HTML (по крайней мере, если для него есть графические редакторы)? У меня был бы подход, который я мог бы легко обрисовать для Markdown -> PDF в Linux (который, вероятно, будет работать и в Windows, который я не могу протестировать).
PDF тоже хорош, но редактор должен быть обычным текстовым редактором — пользователи недостаточно технически подготовлены ни для чего другого.
Хорошо, тогда, возможно, подойдет что-то вроде основного документа : «основной документ» в основном представляет собой «оболочку» для нескольких отдельных документов. Таким образом, ваши пользователи редактируют «разделы» в отдельных документах и ​​используют мастер-документы, чтобы склеить их вместе. Оттуда вы можете экспортировать, например, в PDF, HTML или что-то еще, что вам нужно и поддерживается (AFAIR, вы даже можете создавать электронные книги EPUB таким образом).

Ответы (3)

Одним из вариантов для рассмотрения является Sphinx , который может выводить документацию в нескольких форматах.

Функции:

  • Текст хранится как реструктурированный текст , который представляет собой обычный текст, поэтому его версия легко контролируется.
  • Бесплатно, бесплатно и с открытым исходным кодом
  • Кроссплатформенность (написана на питоне)
  • Выходные форматы: HTML (включая HTML-справку Windows), LaTeX (для распечатываемых версий PDF), ePub, Texinfo, справочные страницы, обычный текст.
  • Обширная индексация, перекрестные ссылки и т. д.
  • Иерархическая структура: простое определение дерева документов с автоматическими ссылками на братьев и сестер, родителей и детей.
  • Встраивайте изображения и диаграммы в различных форматах (SVG лучше всего подходит для такого рода вещей) из внешних файлов.
  • Несколько красивых тем или определите свою собственную.
  • Если изменения желаемого внешнего вида могут быть реализованы путем изменения темы и последующего повторного создания желаемого документа (документов).
  • Некоторые примеры сайтов:
Кроме того, много чего можно сделать с помощью reStructuredText без Sphinx.

MS Word уже сделает это за вас. Я могу подтвердить, что я только что проверил ответ на этот вопрос , и он работает.

Перейдите на вкладку «Вставка», затем нажмите «Объект» (он находится в текстовой подкатегории справа). Затем вы увидите следующий скриншот:

введите описание изображения здесь

Перейдите к файлу и установите флажок «Ссылка на файл». Вы можете либо обновить исходный файл (я бы сделал это, чтобы избежать путаницы), либо, если вы находитесь в целевом файле, когда вы пытаетесь его отредактировать, он фактически открывает файл внутри файла. Трудно объяснить, но вы поймете, когда увидите.

Я создал docuemtnA.docx, вставил текст. Затем создал B.docx, добавил в него текст, а в середине, следуя приведенным выше инструкциям, вставил ссылку на A.docx. Затем я обновил A.docx, и содержимое B.doxc отразило изменение без каких-либо действий с моей стороны.

Это работает для MS Word 2010. Те же функции будут доступны и для других версий, но для достижения этого могут потребоваться другие меню.

Поздравляем! Ты теперь герой своего отдела :-)

Я изучаю это, вернусь и обновлю результаты.
Пожалуйста, сделайте (+1), потому что ваша конформация может помочь другим в будущем, так же, как я помог вам - и это то, что такое обмен стеками :-)
Это сработало, как вы сказали, но индекс (также известный как оглавление) не включает ничего из внешних документов Word.
Это и удивительно, и разочаровывает; Я, конечно, вижу, как это может быть проблемой. Увы, не могу помочь. Вы можете попробовать спросить на superuser.com или на форуме MS Office. Если у вас это работает, не могли бы вы опубликовать здесь, чтобы помочь другим в будущем.

LaTeX хорошо подходит для этого. Он позволяет документам включать в себя другие документы, а также позволяет писать макросы для исключения повторяющихся элементов других типов. Работать с ним, как правило, намного менее приятно, чем со Sphinx (TeX уже реально показывал свой возраст 10 лет назад), но он позволит вам делать всякие причудливые штуки для верстки, если у вас есть на это терпение, что будет полезно если руководства предназначены для печати и выглядят красиво в печатном виде.

Программное обеспечение для создания и ведения руководств пользователя/обслуживания
СпросиСетьПолитика конфиденциальности1y, 0v