问题标签 [user-manual]

我正在寻找为我们的用户构建帮助手册。在花了一个月的时间记录我经常访问的网站示例后，我发现 Shopify 的帮助手册是迄今为止最好的。

由于我不了解可用的各种框架和技术的最新信息，因此我正在寻找有关我应该使用什么来构建类似（或相同，如果可用）的输入。

https://docs.shopify.com/manual/your-store/orders

我试图弄清楚用于制作此文档的工具是什么。因为我正在寻找一个好的文档工具，最好是免费的..任何建议都值得赞赏c：

如何在应用程序本身中包含/嵌入 .*chm 帮助文件（而不是作为输出中的单独文件）？它可以放在“Resources.resx”中并从那里读取吗？我试过这个方法，但似乎它不起作用......

我正在尝试为内部（非公共）软件应用程序创建一个漂亮、易于维护的用户手册。

在高层次上，这些是要求：

1. 用户浏览的文档将是静态 HTML 页面。
2. 文档需要能够从用户的硬盘中浏览。这些页面不会在 Web 服务器上提供。或者换一种说法，用户硬盘上会有一个顶级doc目录，其中包含初始index.html，然后是包含其余内容的目录树结构。用户可以从他们自己的硬盘上双击index.html以开始使用，并且大多数（如果不是全部）其他内容（页面、图像、视频等）也在用户的设备上。
3. 网站的基本布局需要只是一个带有用户手册目录的左侧窗格，然后右侧包含部分内容。
4. 我更喜欢将原始内容放在易于维护的地方。我在考虑 Markdown，但如果有更好的建议，我愿意接受其他建议。不过，Markdown 看起来非常简单，因此它似乎是原始内容的一个很好的候选者。用户手册开发人员无需了解 HTML 或 CSS 即可添加内容。
   一个。我们运行“something”来将原始内容的 HTML 生成为带有漂亮 CSS 的 HTML。

我觉得这样的东西已经存在，但我似乎没有想出正确的搜索关键字来找到它。

目前，我正在使用一个静态站点生成器，结果有些喜忧参半。我还没有和他们中的许多人一起玩过——我偶然发现了 Hugo ( https://gohugo.io/ )，我一直在玩这个。当我进入雨果兔子洞时，我似乎有时会遇到方钉/圆孔问题。它似乎主要用于生成网络博客，这不是我的确切用例，所以我在让它从用户的设备上工作时遇到了一些困难。它似乎对原始内容的布局方式非常敏感，以提示它如何构建输出 HTML 树结构。我敢肯定，其中一部分只是我的学习曲线问题（我根本不是网络开发人员，所以这对我来说是新的），但有时我感觉我花了更多的时间试图理解 Hugo 为什么/如何呈现 HTML，而不是实际创建内容。

我还在网上看到了关于使用 Doxygen 生成用户手册的传言（尤其是使用Doxygen 的用户手册），但我还没有找到任何关于如何真正实现它的好例子。我们已经在使用 Doxygen 来记录我们的代码，所以这可能是一个不错的解决方案，因为它只是让开发人员弄清楚的一个更少的工具依赖/学习曲线。

任何人都有他们发现做类似他们喜欢的事情的任何解决方案？