问题标签 [user-manual]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
4 回答
2101 浏览

reference - 有没有好的可用用户手册的好例子?

我正在尝试为基于 vb6 桌面应用程序创建用户手册,它应该主要由非技术人员使用来了解如何使用该软件,我还需要它来向客户展示他们购买的产品。

我已经看过之前关于最佳实践的讨论,但我正在寻找一个可靠的有用的用户手册,用于真实的产品,这样我就可以更好地了解要编写或包含的内容。它不一定是桌面应用程序或基于 vb6,我只是想寻找一些灵感。

谢谢。

0 投票
4 回答
13390 浏览

php - 编写基于 HTML 的用户手册的最佳软件

我正在做一个项目,我需要为一个软件生成最终用户文档。在明年的某个时候,我正在编写此文档的软件将被淘汰。因此,我不希望在专业级手册上花费大量时间。这是大学的研究生和一些内部专业人士会看到的。虽然如果它足够好和有用,我可能会将它作为免费文档反馈给开源社区。

我在想 HTML 手册会很合适。该软件是用 PHP 编写的,因此无论谁使用它,都将打开一个 Web 浏览器并准备就绪。这也导致我或其他人有可能将手册的页面集成到软件本身中。

我对为这个软件制作/使用 wiki 不感兴趣。我真正想要的是一款可以像普通文档一样编写并生成简单 HTML 的软件。我知道有 Dreamweaver 和 Frontpage 之类的软件,但我对旨在简化文档创建过程的软件特别感兴趣(其中截屏和视频的过程与简单的图像/视频编辑集成在一起)。

如果您认为另一种方法(HTML 文档除外)可能会更好,我很想听听。如果您有另一种方法,并且您认为您知道实现此目的的良好软件解决方案,请告诉我。

我对方法和实现它的软件的主要愿望是

  • 部署简单(HTML 页面不需要特殊设置。可以简单地部署一个帮助目录,其中包含所有手册页)
  • 无需使用特殊软件(每个拥有网络浏览器的人都可以阅读 HTML)
  • 编写文档的易用性/小学习曲线(我不想花很多时间学习一个复杂的软件来处理一个相对较小的项目)
  • 能够将文本、视频和图像组合到单个文档中(HTML 页面显然支持将所有这些显示在一起)

谢谢!

@Lie Ryan:“MediaWiki 将所有文本和数据(内容页面、用户详细信息、系统消息等)存储在数据库中......”这是我想要避免的。我认为 wiki 很棒而且很有用,但我只对以非常低的开销提供静态数据感兴趣。

0 投票
7 回答
24606 浏览

windows - 自动截取程序窗口的屏幕截图

我正在寻找一种将宏录制与截图功能相结合的软件。

我们有一个包含许多屏幕截图的软件手册。当新版本的软件发布时,我们需要更新大部分屏幕截图,我们必须手动完成。现在我们开始将手册翻译成多种语言,截图数量增加了十倍。我们想自动化这个过程。

将有一个录制的宏或点击我们软件中的按钮并截取程序窗口的屏幕截图。更好的是,我们可以单独指定每个屏幕截图的名称,尽管它不太重要。

这样的事情存在吗?

0 投票
0 回答
5707 浏览

android - 如何在 Android App 中创建用户手册?

我看到了一些应用程序的漂亮用户手册。在那里,当用户进入一个新页面时,它的大部分表面都是灰色的,除了用户必须点击它的区域。此外,这里用户看到了一些提示。例如像这张图片:

在此处输入图像描述

当用户点击较亮的区域时,将显示下一个提示,例如:

在此处输入图像描述

现在我的问题是:我们如何创建用户手册或用户提示,比如这些?

0 投票
3 回答
97648 浏览

clang - Clang 优化级别

对于 gcc,手册解释了-O3,-Os等根据特定优化参数 ( , 等) 翻译-funswitch-loops-fcompare-elim内容

我正在寻找 clang 的相同信息

我在网上查看过,man clang其中仅提供一般信息(-O2优化比 更积极-O1-Os优化大小,...),并且还查看了 Stack Overflow 并找到了这个,但我在引用的源文件中没有找到任何相关内容.

编辑:我找到了答案,但如果有人有指向用户手册的链接,该用户手册记录了所有优化过程和. 目前我刚刚找到了这个通行证列表,但没有关于优化级别。-Ox

0 投票
3 回答
11047 浏览

android - Android:如何在启动应用程序时实施用户手册或应用程序说明

我是 Android 开发的新手,我需要在启动应用程序时展示类似 Flip-kart 应用程序的用户手册。

请参考下图,您将了解,我实际上想要实现什么......

有没有标准的方法来实现这一点?

在此处输入图像描述

0 投票
2 回答
80 浏览

android - 用于托管产品用户手册的 Android 应用程序

我正在寻找创建一个 Android 应用程序,其唯一目的是显示和导航我拥有的 PDF 形式的产品用户手册。

我希望应用程序提供带有“目录”之类的导航抽屉的基本导航,一个将显示当前正在显示的部分的标题的操作栏,也许还有一个带有页面导航的底部栏和该部分的进度条.

我在想我可以简单地将 PDF 分成小部分 PDF 文件,然后在导航抽屉中简单地显示相应的块。主要要求是它在没有互联网连接的情况下完全可用和访问,但是,我认为这消除了 WebView 作为一个选项。或者,Android 提供了一种无需互联网连接即可在应用内集成 HTML 结构化静态页面的方法。我只想利用 PDF 或 HTML 页面可能提供的一些格式。我是 Android 开发的新手,所以我对所有特性和功能都没有很好的掌握。

我正在寻找任何可以为我指明正确方向的有用建议。

0 投票
1 回答
118 浏览

git - 在 `git rebase` 中指定两个 blob 是什么意思?

我的问题分为两部分。

第一部分:两个斑点git rebase

我熟悉git rebase -i HEAD^n,其中n表示您希望重新定位到的提交次数。

但是,我有时也会看到git rebase -i <branch> HEAD<branch>在这种情况下 - 添加的参数如何产生影响?

第二部分:git rebase 的手册页

所以....我检查了手册页,我看到以下内容:

git rebase 的手册页概要

在那个手册页上,我看到[<upstream> [<branch>]]了,我认为这可能会回答我对第一部分的问题。

但是,关于这个的特殊之处在于,我知道这<>意味着强制参数,并且[]意味着可选参数。在[<upstream> [<branch>]]中,我在可选参数中看到了一个强制参数。这是什么意思?

0 投票
1 回答
828 浏览

documentation - Doxygen 用户手册

我正在尝试使用 doxygen 为我的库编写用户手册/教程(类似于 doxygen 本身的用户手册!-链接

我使用 .md 文件的mainpage页面来创建我的文档层次结构。我最终得到了类似于 OpenCV(链接)的东西,看起来相当不错,但它仍然没有 doxygen 用户手册的很多功能。例如,左侧的页面/部分索引和右侧的分页目录。

有什么方法可以生成可扩展的索引/目录并使用 doxygen 将其附加到每个页面中(如link)?这样做有没有更好的办法?还有其他提示吗?

0 投票
1 回答
134 浏览

web - 如何制作网站用户手册?

我在我的 HMI(人机界面)课程上有这个项目,我们的教授希望我们为网站制作用户手册,但我不确定用户手册是什么。我在网上搜索,我看到的是用户手册应该解释网站上的不同按钮以及如何导航,但我仍然不确定我教的用户手册是由显示网站网页的图表组成的。