Лучшее программное обеспечение для написания HTML-кода руководства пользователя [закрыто]

В настоящее время этот вопрос не подходит для нашего формата вопросов и ответов. Мы ожидаем, что ответы будут подтверждены фактами, ссылками или опытом, но этот вопрос, скорее всего, повлечет за собой дебаты, аргументы, опросы или расширенное обсуждение. Если вы считаете, что этот вопрос можно улучшить и, возможно, снова открыть, посетите справочный центр , чтобы получить рекомендации.

Закрыт 7 лет назад .

Я работаю над проектом, в котором мне нужно создать документацию для конечного пользователя для части программного обеспечения. В какой-то момент в следующем году часть программного обеспечения, которое я пишу для этой документации, будет удалена. Поэтому я не хочу тратить много времени на руководство профессионального уровня. Это то, что увидят аспиранты колледжа и несколько штатных специалистов. Хотя если он достаточно хорош и полезен, Я мог бы вернуть его в сообщество открытого исходного кода в виде бесплатной документации.

Я думал, что руководство в формате HTML подойдет. Программное обеспечение написано на PHP, поэтому у того, кто его использует, будет открыт и готов к работе веб-браузер. Это также приводит к возможности для меня или кого-то другого интегрировать страницы руководства в само программное обеспечение.

Я не заинтересован в создании / использовании wiki для этого программного обеспечения. На самом деле я ищу программу, в которой я могу писать как обычный документ и генерировать простой HTML. Я знаю, что есть такие программы, как Dreamweaver и Frontpage, но меня особенно интересовало что-то, предназначенное для упрощения процесса создания документации (где процесс создания экранных шапок и видео интегрирован вместе с простым редактированием изображений / видео).

Если вы думаете, что другой подход (кроме HTML-документации) может быть лучше, я бы хотел его услышать. Если у вас есть другой подход и вы думаете, что знаете хорошее программное решение для этого, дайте мне знать.

Мои основные пожелания в отношении подхода и программного обеспечения для его достижения:

Простота в развертывании (HTML-страницы не требуют специальная настройка. Справочный каталог может быть просто развернут со всеми страницами руководства в нем)
Для использования не требуется специального программного обеспечения (HTML может быть прочитан всеми, у кого есть веб-браузер)
Легкость использования для меня, написав документация / небольшая кривая обучения (я не хочу тратить много времени на изучение сложного программного обеспечения для работы над относительно небольшим проектом)
Возможность комбинировать текст, видео, и изображения в отдельные документы (HTML-страницы, очевидно, поддерживают отображение всего этого вместе)

Спасибо!

@Lie Ryan: «MediaWiki хранит весь текст и данные (страницы содержимого, сведения о пользователях, системные сообщения и т. д.) в база данных ... "чего я хочу избежать. Я думаю, что вики - это здорово и полезно, но меня просто интересует предоставление статических данных с очень низкими накладными расходами.

задан Jazzepi 27 September 2010 в 23:44

0 ответов

Другие вопросы по тегам:

php html multimedia end-user user-manual

Лучшее программное обеспечение для написания HTML-кода руководства пользователя [закрыто]

0 ответов

Похожие вопросы: