Лучшее программное обеспечение для написания руководств пользователя на основе HTML
Я работаю над проектом, в котором мне нужно создать документацию для конечного пользователя для части программного обеспечения. В какой-то момент следующего года часть программного обеспечения, которую я пишу для этой документации, будет удалена. Поэтому я не хочу тратить много времени на профессиональное руководство. Это то, что увидят выпускники колледжа и несколько профессионалов. Хотя, если он хорош и достаточно полезен, я могу отправить его обратно в сообщество open source в качестве бесплатной документации.
Я думал, что руководство HTML будет хорошо подойдет. Программное обеспечение написано на PHP, поэтому любой, кто его использует, будет иметь открытый браузер и готов к работе. Это также приводит к тому, что я или кто-то еще могу интегрировать страницы руководства в само программное обеспечение.
Я не заинтересован в создании / использовании вики для этого программного обеспечения. Что я действительно ищу, так это программный продукт, где я могу писать как обычный документ и генерировать простой HTML. Я знаю, что есть такие программы, как Dreamweaver и Frontpage, но меня особенно заинтересовало что-то, предназначенное для облегчения процесса создания документации (где процесс создания снимков экрана и видео интегрирован наряду с простым редактированием изображений / видео).
Если вы думаете, что другой подход (кроме HTML-документов) может быть лучше, я хотел бы услышать это. Если у вас есть другой подход, и вы думаете, что знаете хорошее программное решение для достижения этого, дайте мне знать.
Мои главные желания в отношении подхода и программного обеспечения для его достижения:
- Простота развертывания (HTML-страницы не требуют специальной настройки. Справочный каталог может быть просто развернут со всеми справочными страницами в нем)
- Для использования не требуется никакого специального программного обеспечения (HTML может читать каждый, у кого есть веб-браузер)
- Простота использования при написании документации / небольшая кривая обучения (я не хочу тратить много времени на изучение сложного программного обеспечения для работы над сравнительно небольшим проектом)
- Возможность объединять текст, видео и изображения в один документ (HTML-страницы, очевидно, поддерживают отображение всего этого вместе)
Спасибо!
@Lie Ryan: "MediaWiki хранит весь текст и данные (контентные страницы, пользовательские данные, системные сообщения и т. Д.) В базе данных...", чего я хочу избежать. Я думаю, что вики - это здорово и полезно, но я просто заинтересован в предоставлении статических данных с очень низкими издержками.
4 ответа
Всякий раз, когда мне требуется написать руководство пользователя (т.е. каждый раз, когда я заканчиваю проект), мне нравится использовать Markdown. В сочетании с минимальным CSS, он очень прост в использовании.
Markdown - это инструмент преобразования текста в HTML для веб-авторов. Markdown позволяет писать с использованием простого для чтения, простого для записи простого текстового формата, а затем преобразовывать его в структурно допустимый XHTML (или HTML).
Таким образом, "Markdown" - это две вещи: (1) синтаксис форматирования простого текста; и (2) программный инструмент, написанный на Perl, который преобразует форматирование простого текста в HTML.
Я думаю, это не совсем соответствует вашим требованиям, но я большой поклонник Сфинкса. Вы пишете свою документацию в ReST, и вы можете легко создавать HTML и PDF версии. Генерация HTML использует шаблоны, так что это довольно настраиваемый. Кроме того, есть дополнительное преимущество наличия текстовых версий (ReST несколько читабелен как есть) для тех из нас, кому нравятся такие вещи:)
Написать руководство на XML, использовать что-то вроде docbook. Это позволит вам делать с содержимым все, что вам нужно, а затем генерировать презентацию по-своему.
Там много учебников по документам для HTML инструментов там.
Изменить: я забыл упомянуть, что ОО может сохранить в Docbook.
Я бы предложил просто написать его в OpenOffice и опубликовать в PDF. PDF, возможно, даже больше, чем HTML, не зависит от платформы и выглядит практически одинаково для нескольких клиентов и операционных систем. Если вы действительно хотите видео, вы можете сделать ссылку на внешний веб-сайт, такой как Youtube или что-нибудь еще из PDF.