Questions tagged «help-documentation»

4
example.org的电话号码等于多少?
RFC 2606标准保留了example.org,example.net和example.com域名,以用作文档中的示例。 可以用作示例的电话号码(包括国家代码)的等效项是什么,例如,为用户提供以哪种格式输入电话号码的示例? 在最佳情况下,它将是由相关标准指定的虚拟号码作为示例电话号码,并且不会归属于任何真实订户。

6
如何记录我的代码以进行最短时间检查?[关闭]
已关闭。这个问题需要更加集中。它当前不接受答案。 想改善这个问题吗?更新问题,使其仅通过编辑此帖子来关注一个问题。 去年关闭。 我想记录我的代码,以使几个月后再次阅读和浏览代码的需求降至最低。 我知道有不同类型的文档(在源代码中和外部,序列图等中)。 我只想知道什么是记录我的代码的有效方法,所以几个月后我想看我的代码时,我花更少的时间在阅读代码和理解代码流上。

5
替代HTML帮助
当前,我们使用一个名为AsciiDoc的系统,该系统使我们可以使用简单的文本标记创建文档。由此,我们可以生成多种输出格式。我们仅使用pdf输出和chm输出格式。 我想知道是否有chm替代品?我正在寻找的是可以离线使用我们的软件的东西(这很重要,因为我们的很多用户都位于非常遥远的地方)。它应该有一个索引(它可以像带有超链接术语的html页面一样简单),应该是可搜索的,并且它应该具有一种允许从代码中调用特定条目的机制(类似于上下文相关的帮助)。 在这种情况下,针对PDF的两件事是: 上下文相关帮助不是一种选择 通常文件比较大 PDF比上下文相关帮助更适合打印文档 我想要的是使用html。html的唯一问题是,我似乎无法弄清楚如何自动提供关键字搜索(除了浏览器的ctrl + f功能外,我希望更明显)。我似乎也找不到自动生成关键字的超链接索引的方法。由于有section标签,因此上下文相关的帮助将非常简单-我可以简单地将我感兴趣的页面和部分的url传递给默认浏览器,并且该页面应加载到正确的部分。 我的要求听起来像chm一样糟糕-确实如此。我根据chm建模了需求。我不喜欢chm的唯一原因是因为代码使用mapids等与之交互的方式。我宁愿使用存储纯文本列表(为我自动生成)的方式,我的代码可以使用该列表访问文档的上下文相关部分。 我正在构想一个脚本,该脚本将遍历html输出文件并生成一个索引页面,该页面仅包含找到的关键字列表。显然,应该有单词排他机制来忽略诸如“ the”,“ it”,“ is”等单词。这部分将相对容易编写。第二部分将需要某种脚本来将关键字数据库及其在html文本中的位置放在一起。我认为这将是棘手的部分,同时在浏览器中提供搜索机制。 关于替代方案的任何想法将不胜感激。我很想使用托管在某处Web服务器上的Wiki或一组静态html页面,但是我们有一个关键的离线使用要求。只是将html放在本地驱动器上并不能满足我们所需的搜索要求。 编辑: 我设计了采矿业使用的软件。许多地雷都很偏远,无法以任何有意义的方式访问互联网。pdf或html或chm没什么问题(除了它变老了)。如果我可以在正确的位置显示pdf文件(即上下文相关帮助),则可以使用它。我几乎想写自己的东西-基本上它将是便携式Wiki。说到这一点,如果您建议使用便携式Wiki,则必须考虑最终用户,他们可能没有使用此类工具的经验。它必须完全简单。那是chm的美丽,与之合作很痛苦,但最终用户喜欢它。
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.