CMS-подобная структура справки для веб-приложений?
У нас есть относительно большое веб-приложение (>200 страниц), к которому мы должны начать добавлять экраны справки. Нам было интересно, есть ли CMS-подобное приложение, которое особенно хорошо подходит для таких задач (вместо того, чтобы пытаться создавать все экраны редактирования владельца бизнеса, искать, форматировать и т. Д.).
Какие-либо предложения?
3 ответа
Самый быстрый и простой способ сделать это - взять что-то вроде ScrewTurn Wiki, которое идеально подходит в качестве базы знаний, и просто создать справочные ссылки на экраны справки на вашем существующем сайте.
Если ваше приложение уже MVC, почему бы не добавить в него контекстную помощь...
Например, на странице макета добавьте значок, который просто переводит пользователя на страницу справки, пропуская ссылающуюся страницу. URL будет
Если бы вы были на
YourApp/Customer/Create/
затем
YourApp/Help/Customer/Create/
Тогда у вас может быть HelpController, который ищет справку для CustomerController, и, в частности, действие Create, которое позволяет вам предоставить очень детальную помощь, а также обратиться к более общей помощи, если конкретная помощь недоступна.
Вы можете даже перенаправить на CMS, которая содержит информацию, если вы не хотите писать эту часть самостоятельно, вам просто нужно сохранить отображение на странице CMS, которая предоставляет справку по данной теме (или использовать аналогичное соглашение - основанный маршрут для содержания).
Вот правило маршрутизации для вашего файла Global.asax.cs.
routes.MapRoute(
"Help",
"Help/{controllerName}/{actionName}",
new { controller = "Help",
action = "Details",
controllerName = UrlParameter.Optional,
actionName = UrlParameter.Optional }
);
Вы смотрели @ Орчард? Это CMS на основе MVC (как WordPress). Я думаю, что вы могли бы установить Orchard на что-то вроде /Help в своем приложении и создать "Посты" для каждой из ваших тем справки. Используя функции "Чистый URL", вы сможете легко сгенерировать соответствующие ссылки из своего пользовательского приложения. (~/Help/Module1 например). Здесь также есть поиск, роли и, возможно, большинство других вещей, которые вы будете искать.
Единственная часть, на которой я не на 100%, это стиль, но из того, что я прочитал, это выглядит довольно легко сделать.