Создать справку и руководство для приложения MVC - PullRequest
2 голосов
/ 08 июля 2011

У меня есть небольшое приложение, которое должно иметь профессионально выглядящий раздел справки / руководства. Помощь будет состоять из:

  • HowTos
  • FAQ
  • Ссылки

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

Спасибо за помощь

1 Ответ

2 голосов
/ 08 июля 2011

для нового приложения MVC, которое мы разрабатываем сейчас, мы планируем использовать внешний справочный сайт в форме вики.Существуют вики-движки, такие как mediawiki и другие, идея в том, чтобы иметь контекстно-зависимую справку (разные страницы справки, открытые на разных страницах приложения), а также позволить пользователям добавлять контент, такой как формулы и примеры, позже.

Классная вещьявляется то, что вики-трек меняется и делает версионирование для нас и бесплатно, поэтому помощь может расти, будучи полностью отделенной от исходного кода нашего приложения, и пользователи могут видеть, кто добавил, что, если они хотят.

в нашем случае, этотолько интранет-приложение, поэтому фактически у нас нет проблем с безопасностью во внутренней сети.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...