Кто-нибудь может порекомендовать программу для создания руководств пользователя? Не язык разметки (например, LaTeX или DocBook), а нечто интерактивное, например Scribus. Поскольку я не единственный, кто будет обновлять руководство, программное обеспечение должно быть чем-то, что новичку будет легко понять, но все же имеет некоторые расширенные функции (например, ссылки в тексте из внешних источников / таблиц, обработка мастер-страниц / тем и т. Д.) .
С уважением, Оскар
Программное обеспечение для технических публикаций - обзоры FrameMaker и его альтернативы
Я подготовил документы по спецификациям с помощью LaTeX и Framemaker и разработал рабочий процесс Framemaker для поддержки команды из 5 аналитиков, разрабатывающих спецификацию для системы страхового андеррайтинга. Предполагалось, что в документе будет около 2000 страниц. Много лет назад (примерно 1992–1993) я тоже некоторое время работал наборщиком.
Framemaker разработан для технической документации и делает это действительно очень хорошо. Он также имеет функции, предназначенные для поддержки очень больших документов с несколькими авторами - люди используют эту систему для создания документов, содержащих более 100 000 страниц. Он также более доступен, чем LaTeX, для пользователей, знакомых с программным обеспечением для обработки текстов.
Основные возможности Framemaker:
Документы, состоящие из нескольких файлов: вы можете собрать "Книгу" с несколькими подразделами в разных файлах. Документ также можно сохранить в системе контроля версий.
Текстовый формат MIF для импорта / экспорта: Импортер несколько привередлив (я обнаружил, что создание рабочего LaTeX проще), но вы можете создавать такие элементы, как словари данных, и импортировать их в документ. В файле есть текстовые привязки (см. Ниже), поэтому вы можете создавать перекрестные ссылки, которые будут стабильными при импорте. Я считаю, что это ключевая особенность спецификаций, поскольку она позволяет перекрестным ссылкам напрямую ссылаться на сгенерированные элементы.
Мощная система тегов, индексации и перекрестных ссылок. Все основано на тегах в Framemaker, и их легко быстро применять. Это означает, что создание перекрестных ссылок, индексирование, условный текст и массовое применение стилей очень просто и просто работает. Вы можете создавать индексы и оглавления на основе тегов, поэтому иметь несколько специализированных индексов (например, список имен полей данных с экранов или словарь данных) легко. Документ, который я описал выше, имел 4 отдельных указателя.
Стабильно: Framemaker разработан для профессионалов, поэтому он не заставит вас усомниться в том, как это слово делает. Это также намного более стабильно для больших документов. Любой, кто пытался написать в Word документ объемом более 50-100 страниц, должен иметь довольно четкое представление о том, что это означает.
Scriptable: FM имеет API C и различные плагины для сценариев (FrameScript и FMPython, вероятно, наиболее широко используемый ), который можно использовать для автоматизации заданий в FM. Framemaker 10 добавляет поддержку инструмента сценариев на основе Javascript под названием Extendscript, предположительно перенесенный из средства создания сценариев в InDesign.
Единый источник: из одного документа FM вы можете довольно легко создавать PDF, справку Windows (CHM), HTML и распечатывать документы. Перекрестные ссылки также разрешаются в гиперссылки.
Глобальные элементы управления стилем: вы можете легко настроить стили для документа и применить их ко всему документу. Это также облегчает запуск верхних и нижних колонтитулов с большой гибкостью, позволяя отслеживать разделы, версии, главы и т. Д.
Альтернативы Framemaker
LaTeX / Lout: вы уже указали, что вам нужен не язык разметки, а Системы TeX и Lout используются для больших структурированных документов и делают это хорошо.
Издатель Ventura: Вероятно, это единственная реальная альтернатива Framemaker, если вам нужен такой пользовательский интерфейс, не платя за эту привилегию физическими частями. Он имеет сильную поддержку для структурированных документов и формата обмена документами на основе XML. Теперь он принадлежит Corel, который, похоже, все еще активно его продвигает.
На рынке есть несколько других инструментов технической публикации: http://www.broadvision.com/bvsn/bvcom/ep/programView.do?pageTypeId=8155&programPage=%2Fjsp%2Fwww%2Fcontent%2FgeneralContentBody.jsp&programId=8297&channelId=-9482&BV_SessionID=NNNN1185750526.1229445772NNNN&BV_EngineID=ccccadeejdjfiegcefecefedgfhdfng.0 (который использовался как http://www.http://www.google.com/html/nofollownoreferrer). wiki / Interleaf "rel =" nofollow noreferrer "> Interleaf) и ArborText . Эти два мощных инструмента - когда-то Interleaf был лидером рынка в этой области - но довольно дорого.
Adobe Indesign: Хотя Adobe утверждает, что вы можете создавать большие документы с InDesign, перекрестные ссылки и другие функции больших документов, как правило, рассматриваются поклонниками Framemaker как отсутствующие. Однако существует система ввода текста под названием InCopy, которая, по-видимому, имеет такой вид функциональности и довольно большое количество сторонних плагинов, некоторые из которых поддержка тегов и других подобных средств. InDesign также имеет API сценариев и интерпретатор JavaScript для выполнения сценариев.
Я не использовал Indesign, поэтому не могу сказать, насколько хорошо он работает на практике.
DocBook: это действительно стандартный формат для структурированных документов, но имеет большой экосистема окружающих его инструментов для написания и рендеринга документов. Если вы не хотите использовать LaTeX, вы, вероятно, не захотите использовать DocBook по тем же причинам. Как указывает Винко Врсалович ( +1), Эта ссылка переходит к сообщению StackOverflow от кого-то, кто описывает использование DocBook на практике. Я никогда по-настоящему не использовал DocBook, и я так много редактировал этот пост, что теперь он находится в режиме Wiki, так что кто-то, знакомый с DocBook, может захотеть подробнее рассказать об этом.
Программное обеспечение для обработки текста: Word как инструмент технической публикации имеет серьезные недостатки и не рекомендуется. OpenOffice имеет несколько лучшую функциональность структурированной документации, чем Word, и может быть лучшим выбором, если политика или требование использовать .doc поскольку формат обмена документами исключает лучшую альтернативу. Chromalin < / а>. Это делается на основе фактических разделений пленки (и, следовательно, довольно дорого), поэтому дает точную передачу фактического цвета окончательного отпечатанного изделия. Выполнение этого для нескольких страниц с образцами даст вам точную информацию о том, правильно ли настроена ваша калибровка.
Благодарности: Спасибо Эйдану Райану за расширение раздела о продуктах Madcap.
Я бы порекомендовал "Справку и руководство" от EC Software. Вы можете создать печатное руководство, PDF-файл, файл справки Windows (CHM) и веб-справку в формате HTML из единого исходного документа.
Я слышал много хорошего о FrameMaker. Я сам не использовал его, но мне рекомендовали его именно для такого приложения.
Adobe Framemaker действительно является классическим инструментом для написания руководств пользователя. Я использовал его для всех видов длинных документов, и он очень хорошо работает. Жаль, что Adobe оставила его гнить на долгие годы, прежде чем заметила, что пользователи не переключатся.
MSWord потребовалось до 2003 года, чтобы избавиться от ошибок в пуле / нумерации, и я не знаю, наконец-то удалось заставить их работать с основным документом.
LaTeX по-прежнему является разумной альтернативой. Формат легко обрабатывать, и вы можете сгенерировать его из вики.
Если вам нужна совместная работа, то подход на основе языка (я бы предпочел LaTeX, хотя подходы на основе XML тоже хороши - Docbook здесь является флагманом) действительно имеет смысл, особенно если вы отслеживаете файлы с помощью системы контроля версий.
Все, что действительно усложняет ситуацию, например, любое программное обеспечение в двоичном или проприетарном формате, здесь вам не поможет.
Извините, если это не тот ответ, который вам нужен.
Я согласен с Оливье в том, что использование DocBook (или LaTEX) - это самый разумный подход к простому преобразованию, разумному форматированию и хорошему контролю версий.
К счастью, вы можете попробовать и съесть свой торт с помощью редактора DocBook.
Попробуйте те, что в этом списке, и посмотрите, удовлетворяет ли какой-либо из ваших потребностей (я не использовал ни одного ).
Мы используем «Справку и руководство» из программного обеспечения EC, и оно работает довольно хорошо. Наши авторы распространены по США, поэтому мы делимся нашими файлами содержимого через размещенный сервер SVN для управления версиями. На каждой рабочей станции мы используем Tortoise SVN для синхронизации. Продукт чрезвычайно прост в использовании и продуктивен.
ОЧЕНЬ хорошее объяснение того, что использует О'Рейли (на самом деле тот, кто продает все эти книги ...):
Это может показаться сложным, но в зависимости от количества страниц, которые вы собираетесь написать, вам, возможно, следует уделить этому внимание.
Word (или ваш любимый текстовый редактор)
Я делаю все свои руководства пользователя (не путать с пользовательскими файлами HELP) в Word. Затем я могу определить, должны ли они быть в формате PDF, RTF, DOC или даже преобразованы в HTML. Чтобы решить проблему многопользовательского обновления, я сохраняю файл в системе управления версиями, которая обрабатывает все эти забавные вещи.
См. Блог Fastware Project для подробного обсуждения компромиссов использования DocBook и т. Д. Скотт Мейер попробовал много возможностей и делится тем, что думает.
Adobe InDesign CS5.5 намного лучше справляется с перекрестными ссылками и длинными документами, чем более ранние версии. Это очень мощный инструмент, который относительно прост в изучении и использовании. Набор функций очень богат, и чем больше вы узнаете о нем, тем больше вы сможете с ним сделать. Он поддерживает очень мощные функции XML и может при необходимости импортировать и экспортировать XML. Он также может сопоставлять стили с тегами и теги со стилями, что позволяет создавать XML автоматически, если вы просто используете полный набор стилей символов и абзацев. Я использовал эту программу в течение многих лет и создал множество проектов, от книг до разовых рекламных объявлений. Это инструмент графического дизайна, но он поддерживает многие аспекты книжного и ручного производства. Я рекомендую его, если вас больше интересует графика, изображения или иллюстрации. InDesign поддерживает большое количество форматов импорта и экспорта.
В InDesign CS5.5 добавлена и улучшена поддержка как интерактивного контента, так и экспорта в форматы электронных журналов EPUB (электронная книга) и Adobe Digital Publishing Suite (DPS).
Framemaker - отличный инструмент для книг, руководств и длинных технических документов. Его немного сложнее изучить, чем InDesign, но он имеет более богатый набор инструментов для создания переменных и запуска верхних и нижних колонтитулов, если у вас есть время и желание научиться их использовать. Он также имеет очень надежный набор функций XML, но я лично им не пользовался.
К сожалению, Framemaker не поддерживает графический дизайн. Цветовая система очень нечеткая, и точечные (PMS) цвета сложно определить. Простые вещи, такие как добавление цвета обводки и цвета заливки, в лучшем случае являются элементарными. Например, вы по-прежнему не можете выбрать цвет обводки, отличный от цвета заливки объекта. Программа предназначена для вывода на лазерные и струйные принтеры, а не на печатные машины.
Одна из действительно интересных функций - это возможность применять главные страницы на основе стилей абзацев, отображаемых на странице. Нумерация абзацев / иллюстраций в Framemaker превосходит любую другую программу, которую я когда-либо использовал. Но его также сложно выучить и использовать.
Обе программы поддерживают вывод в форматы файлов PDF и PostScript и могут создавать гиперссылки и интерактивный контент.
