Изменить: некоторые разъяснения :
- Мы уже используем справку и руководство для наших файлов справки
- Вопрос действительно в том, что использовать, что позволяет нам делать гиперссылки из файла справки на презентацию и обратно, и при этом презентация должна быть «легко презентабельной».
Сначала я рассмотрю вопрос о преобразовании файлов PowerPoint в HTML, чтобы понять, работает ли он для нас. Это очень хорошо, может.
Я прошу прощения за длинный вопрос, и я отметил его субъективно, потому что, вероятно, нет единого ответа.
Мы находимся в состоянии переоценки инструментов, которые мы используем, чтобы предоставить различные источники информации для наших конечных пользователей.
Вот что мы должны на сегодняшний день:
- Файлы CHM с помощью нашего продукта (или несколько файлов .html для сетевых ресурсов).
- Файлы PowerPoint с презентациями, используемые на семинарах и занятиях по использованию нашего продукта
- HTML-файлы и аналогичные с инструментами электронного обучения
- Файл слов со всеми техническими изменениями и изменениями продукта, исправлениями и т. Д., Которые мы делаем от одного основного выпуска к следующему
Мы обнаруживаем, что было бы чрезвычайно полезно попытаться объединить все в одном продукте.
У меня такой вопрос: кто-нибудь был в такой ситуации, и что вы делали? На какие инструменты ты смотрел, нашел ли ты какие-нибудь хорошие, чем ты сейчас занимаешься? Наша главная проблема с интеграцией всего в одну систему состоит в том, что часть PowerPoint, в которой вы помещаете слайд с ключевыми словами на проектор, а затем переходите от слайда к слайду, становится проблематичной, если в интегрированной системе не установлен своего рода «режим проектора» с легкая навигация, то, чего не делают чистые html-страницы, если они не написаны с учетом этого.
Во всяком случае, преимущества ...
Например, мы могли бы предоставить стабильные гиперссылки с одной «системы» на другую, чтобы, например, презентации могли содержать ссылки на соответствующие части файла справки. Пользователи получают собственную копию файлов презентации, когда покидают наш класс, чтобы они могли открыть их и использовать, когда вернутся на свое рабочее место, и поэтому было бы удобно облегчить им поиск связанных материал, не полагаясь на них, или их ИТ-персонал, чтобы сделать все 100% правильно при размещении файлов на своих компьютерах.
С нашей текущей настройкой гиперссылка из файла PowerPoint имеет относительный адрес к соответствующей части файла справки, и если пользователь не организует файлы PowerPoint и .HTML локально одинаково (например, каталог переименовано, все в одной папке и т. д.), тогда ссылки не работают, хотя файлы там есть.
Для файлов справки мы используем Help и Manual , и мы думаем о стандартизации этого продукта для большинства вещей. Часть электронного обучения поддерживается отдельной компанией, поэтому мы не уверены, хотим ли мы сейчас внести это в миксы.
Вот что, по нашему мнению, мы можем получить, объединив changelog + техническую информацию, файл справки и документацию класса в одну систему:
- Стабильные гиперссылки, это работает. Больше не нужно «убедиться, что файлы PowerPoint и файлы html-справки точно расположены на вашем локальном диске», между всеми системами.
- Одна таблица содержания и один индекс, который объединяет все системы в одну (для пользователя это будет файл справки, который получил гораздо больше информации)
- Различные результаты: Мы можем создать один файл .CHM, набор html-файлов, файл слов, pdf-файл, все с кликабельными, рабочими, гиперссылками и различными другими бонусами для поиска связанных материалов из одного и того же исходного проекта. Нет вырезать и вставить из одной системы в другую.
- Мы можем интегрировать все в справочную систему в нашем продукте. Когда пользователь нажимает кнопку справки на форме в нашем продукте, он не только может увидеть файл прямой справки, но и сможет найти презентации класса, которые использовались для обучения этим вещам, а также ссылки на техническую информацию. ИТ-персонал может использовать для устранения неполадок или настройки вещей.
- Несколько человек могут работать над одним и тем же материалом здесь, у нас, в одно и то же время. С объединением файлов PowerPoint и Word они быстро становятся узкими местами в беспокойные периоды, а справка и руководство позволяют нескольким людям работать над одними и теми же проектами одновременно.
- Повторное использование ресурсов, изображений и снимков экрана, созданных для одной «системы», можно повторно использовать в другой, не создавая дубликатов, обновите один (когда новый основной выпуск изменит макет, цвета и т. Д.) И мы обновим их все
Что мы теряем:
- Режим презентации PowerPoint. Одна вещь, которая нас интересует, - это удержание реальных классов, поскольку у докладчика теперь есть html-файл, и он должен обязательно указывать мышью на кнопку «Следующая страница» (которую добавляют Справка и Руководство), вместо того, чтобы иметь возможность используйте одно из этих устройств для быстрого перехода к следующему и предыдущему слайду. Кроме того, на слайды не влияет «одно ключевое слово за раз».
Итак, есть мысли?
источник
Похоже, работа для чего-то вроде SharePoint . У меня есть только ограниченный опыт в этом, но он, кажется, делает все, что вам нужно для этого.
Имейте в виду, что полная функциональность предоставляется только с Microsoft Office SharePoint Server (MOSS), а базовая настройка Windows SharePoint Services (WSS), скорее всего, не даст вам больше. Кикер? WSS бесплатно, MOSS не так бесплатно!
Существуют альтернативы с открытым исходным кодом, но я оставлю других предлагать конкретные пакеты, так как я еще менее знаком с ними.
источник
Извините, если я не понял суть именно то, что вы хотите, но я думаю, что я мог бы-
Лично у меня есть два продукта, которые я продаю, которые требуют огромной документации. Я делаю то, что Microsoft делает с распространением файлов справки.
Один компакт-диск, который содержит все это -
файл автозапуска, который запускает веб-страницу на компакт-диске, имеет приятный макет и хорошую структуру каталогов.
Вы можете иметь / лекции, / документы, / помощь и т. Д. Или / topic1 / лекции / и т. Д.
вы можете иметь общие ресурсы (например, изображения) в / resources / pictures
... После этого вы можете легко раздать диск всем в конце обучения и включить его в свой продукт. Давать новые версии легко ... и в любой момент вы можете просто скопировать корень диска на веб-сайт, и тогда весь диск будет доступен онлайн! (просто используйте относительные пути вместо прямых).
За эти годы я использовал очень много систем управления контентом, но я искренне считаю, что лучше всего делать это самостоятельно и использовать вышеуказанный метод.
Я немного усовершенствовал его, используя такие вещи, как FlashPaper, а также предоставив ссылку на документ.
В любом случае, надеюсь, вам понравится и не стесняйтесь задавать вопросы.
источник
Моя компания также использует Help & Manual, и я полагаю, что это, вероятно, ваш путь. Пользовательский интерфейс не так сложен в освоении, и это единственный известный мне авторский продукт, который поддерживает все перечисленные форматы.
источник
Я использую doxygen для выполнения всего, что вы описываете, кроме презентации в Powerpoint. Звуки Doxygen, на высоком уровне, похожем на «Справку и руководство», являются кроссплатформенными и очень легко настраиваемыми. Если вы знакомы с javadoc или подобными системами документации на основе тегов, вы уже на полпути. Он создает графические документы с высокой степенью гиперссылки. Он разработан для справочных руководств по API, но я «злоупотребил» им для создания практически всех типов документов, которые вы можете себе представить.
Не уверен, на каком языке вы документируете, но doxygen поддерживает многие, и вы можете отфильтровать неподдерживаемые языки, чтобы получить нужный вам результат. Например, хотя это официально не поддерживается, я обычно использую doxygen для документирования своего VB-кода. Я часто генерировал файлы chm, содержащие классы кода и диаграммы сотрудничества, а также определяемые пользователем диаграммы непосредственно из моего исходного кода. Я обычно делаю HTML, но также создаю PDF и RTF. У них есть все гиперссылки, которые вы найдете в документе HTML.
Doxygen автоматически выбирает множество ссылок из структуры вашего программного обеспечения. Основной недостаток, который я обнаружил, заключается в том, что если вам не нравится внешний вид, который doxygen предоставляет по умолчанию, вы должны написать свою собственную каскадную таблицу стилей. Честно говоря, я никогда не знал, сколько стиля может быть жестко закодировано в HTML, создаваемом doxygen.
Похоже, что Help & manual использует XML в качестве формата файла. Doxygen может производить XML. Таблица стилей xml позволит вам переводить один формат в другой. Вы должны написать это сами, но у вас будут все ссылки между всеми вашими документами.
Для меня одно из главных преимуществ использования doxygen не имеет ничего общего с его способностью генерировать документы. Это то, что он позволяет мне обрабатывать всю мою документацию точно так же, как и мой исходный код. Он находится в том же хранилище, я могу видеть и управлять diff-файлами, а также отмечать / размечать документы вместе с кодом. Для меня это огромно.
источник
Я верю, что Zimbra может помочь вам :)
источник