пример интерактивного руководства для веб-приложения [закрыто]

Question

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

Answer 1

Я нашел помощь в механизме сборки Hudson очень элегантной и дискретной.

У вас есть значок справки, вы нажимаете на него, текст справки разворачивается на странице, вы нажимаете еще раз, и он исчезает.

Попробуйте начать https://hudson.dev.java.net/hudson.jnlp перейдите по адресу http://localhost:8080/configure и нажмите множество (?) кнопок с правой стороны.

Answer 2

Java-документ может использоваться для извлечения всех комментариев, включенных в файл кода Java

Answer 3

Посмотрите JavaHelp.Эмулирует справочную систему старых версий Windows.

Answer 4

Очень современно писать документацию в Wiki.Его легко редактировать, удобно структурировать и т. д.
Но я ненавижу это.Я действительно ненавижу это.Он никогда не бывает хорошо структурирован и легко читается.Чтобы сделать вики хорошей, нужно приложить много усилий.

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

Answer 5

Я бы просто использовал старый добрый HTML/CSS - это сохранит поведение, которое пользователи уже знают в браузере, и у вас уже должна быть таблица стилей для приложения, чтобы вы могли поддерживать L&F через страницы справки с небольшими дополнительными усилиями.

Взгляните на справку на Google Maps (http://maps.google.co.uk/support/) - за идеи планировки и т.п.

Когда я просматривал страницы справки Google, я заметил одну вещь — это поиск (без сюрпризов), который может быть немного сложнее — если ваш сайт ориентирован на внешнюю сторону, я бы реализовал это с помощью «site:<».твой сайт>' и воспользуйтесь поиском Google.Если ваш сайт является внутренним, вам придется выполнить собственный поиск, но это не должно быть слишком сложно и, вероятно, будет довольно интересным подпроектом.

Answer 6

Если вы используете PHP, взгляните на phpДокументор.

Инструмент PhpDocumentor-это автономный автодокументиру, похожий на Javadoc, написанный на PHP.

Answer 7

Если вы хотите создать руководство пользователя, иллюстрирующее, что делает каждая кнопка, я нашел использование чего-то вроде Режим отладки Подмигивание или Adobe Captivate, полезный для записи взаимодействия с экраном и последующего преобразования его в видеоролик Flash или PDF.

Answer 8

Специально для Rails:http://github.com/darthapo/comatose/tree/master — отличный небольшой инструмент CMS, который можно использовать для встроенных справочных систем.

В противном случае, http://tenderapp.com/ прекрасно работает как размещенное решение.