2

我面临着为大型项目创建帮助文件的有趣任务。由于限制,我已经丢弃了 CHM 文件,现在正在研究基于 HTML 的文件,但我仍然不确定格式....

我主要关注 3 个领域:

部分的可重用性(许多页面可以引用一个文本) 由于某些部分将在帮助文件中多次使用,因此我需要创建一个主部分,然后链接到每个子部分中的主部分。这样我就避免了在编辑时必须在多个地方更改标题。

搜索功能我希望能够搜索文件中的自由文本。

适印性。用户可以选择打印部分或整个文档。

我最初倾向于使用插件将 wiki 导出到静态页面进行分发的 wiki 方法,但我还没有找到该解决方案......

在这件事上,你们有什么建议吗?我是否使帮助文件变得复杂?

提前致谢!

4

2 回答 2

1

可重用性

我看到两种方法。您可以为要重复使用的部分创建单独的页面,然后在适当的地方简单地链接到它们。这在 HTML 中是微不足道的。

您也可以使用该部分的信息创建一个 HTML 片段或片段,然后使用服务器端包含(或类似技术)将其包含在需要的任何地方。这样,内容似乎已经写在每个单独的页面上,但是当您需要进行编辑时,它仍然只在一个地方。

搜索

如果网站是公开的,让谷歌索引它,并提供一个谷歌搜索框。你不可能得到比这更好的结果。

适印性

CSS 中的“打印样式表”很容易组合在一起,并且可以消除使网站在网络上具有吸引力的所有图形元素,保留所有内容以供在纸上使用。

一次打印整个文档需要一些小的编程来将所有内容组合到一个页面中以进行打印。就个人而言,我什至更愿意提供这项服务,以阻止人们浪费纸张。

当然,我们可以就如何实现这些目标提供各种见解,但既然听起来您目前正在寻求一般性建议,那是我的。

于 2009-08-14T13:20:17.463 回答
0

我相信 wiki 非常适合记录文档,尤其是当不止一个人参与(或将参与)项目时。wiki 页面或名称空间之间的链接很容易实现。重命名页面将更改其他文档中的所有超链接。不过,如果这是您的建议,我会尽可能避免重复内容。

我使用支持页面导出的DokuWiki 。您可以将整个 wiki 转储为纯文本、XHTML 或 XHTML 正文(用于放入您自己的模板中,或附加到单个文件以进行打印等)。

希望有帮助!

于 2009-08-14T14:20:05.460 回答