Question

我有一个小应用程序，需要有专业的帮助/手册部分。帮助将包括：

HowTos
常见问题
参考

我想知道是否有免费（易学）工具可以帮助我以HTML格式制作这些文件？有什么建议吗？

感谢您的帮助

Answer 1

对于我们正在设计的新MVC应用程序，我们现在计划以wiki形式使用外部帮助站点。有像mediawiki和其他的wiki引擎，其想法是获得上下文敏感的帮助（从不同的应用程序页面打开不同的帮助页面），并允许用户随后添加公式和示例等内容。

很酷的是，wiki跟踪更改并为我们免费进行版本控制，因此可以帮助我们完全脱离应用程序源代码，用户可以看到谁添加了他们想要的内容。

在我们的案例中，它只是一个Intranet应用程序，所以实际上我们在内部网络中没有安全问题。

Answer 2

您必须创建或多或少具有MSDN的实例。

它有两列
firsrt列具有描述列表
第二列是文字+图片+视频+链接。

https://docs.microsoft.com/en-US/aspnet/core/tutorials/razor-pages/razor-pages-start?view=aspnetcore-3.1&tabs=visual-studio

最简单的方法是使用静态文件和资源。试试吧。

在ASP .Net MVC中，您可以创建特殊的_LayoutFAQ.cshtml并将其应用于IFRAME页面。

“索引常见问题”页面可能如下所示

@{
    ViewBag.Title = "FAQ";
    Layout = "~/Views/Shared/_LayoutMain.cshtml";
}

<div class="container-fluid">
    <h5 class="mt-1 text-center text-success mb-0">My mega FAQ</h5>
    <hr class="mt-1" />
    <div class="row">
        <div class="col-sm-3 overflow-auto pl-0">
            <ul class="">
                <li><a onclick="NavigateIframe('@Url.Content("~/FAQ/Page1")');"  href="#">Page 1</a></li>
                <li><a onclick="NavigateIframe('@Url.Content("~/FAQ/Page2")');"  href="#">Page 2</a></li> 
            </ul>
        </div>
        <div class="col-sm-9 border-left">
            <div class="embed-responsive embed-responsive-16by9">
                <iframe style="height:80vh!important;" id="pageContainer" class="embed-responsive-item" src=""></iframe>
            </div>
        </div>
    </div>
</div>
<nav class="navbar fixed-bottom  navbar-expand-lg navbar-light bg-light  border-top  border-secondary">
    <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
        <span class="navbar-toggler-icon"></span>
    </button>
    <div class="collapse navbar-collapse" id="navbarSupportedContent">
        <ul class="navbar-nav mr-auto">
            <li class="nav-item active">
                <a href="@ViewBag.PreviousUrl" class="nav-link border border-secondary bottomMenuItem" data-toggle="tooltip" data-placement="top" title="Back"><i class="fa fa-angle-left"></i> Back</a>
            </li>
        </ul>
    </div>
</nav>
@section Scripts {
    @Scripts.Render("~/bundles/jqueryval")
    <script type="text/javascript">
        $(function () {
        });
        function NavigateIframe(url) {
            event.preventDefault();
            $("#pageContainer").prop("src", url);
            return false;
        }
    </script>
}
@section head{
    <style type="text/css">     
    </style>
}

但是，如果您的常见问题解答经常更改，则可能必须像这样https://docs.microsoft.com/en-US/aspnet/core/tutorials/razor-pages/razor-pages-start?view=aspnetcore-3.1&tabs=visual-studio

复制后端和前端

为MVC应用程序创建帮助和手册

2 个答案: