问题标签 [manuals]

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 投票
17 回答
9841 浏览

documentation - 您的团队使用什么工具来编写用户手册?

基本要求是:

  • 人类可读/文本格式(便于版本控制)
  • 在线(用于协作)
  • 轻松格式化(markdown ok,html 太多了)
  • 严格的格式(所以作者不会发明新类型的标题、项目符号等)
  • 可导出为 PDF、HTML
  • 轻松备份和部署(因此我们可以作为只读版本“部署”到客户站点)

我们正在考虑使用某种 wiki 引擎,但它需要使用文件进行存储或对客户有其他“部署”方式,并且易于安装/维护。此外,它必须是免费/便宜的(confluence 太贵了)

有什么建议么?

编辑:我不是在寻找记录代码的工具,我们已经使用 Sandcastle 进行了介绍。

0 投票
11 回答
7914 浏览

pdf - 用于制作用户手册的应用程序(不是标记语言)

任何人都可以推荐一个程序来创建用户手册吗?不是一种标记语言(如 LaTeX 或 DocBook),而是更像 Scribus 之类的交互式标记语言。由于我不是唯一会更新手册的软件,因此该软件应该是新手容易上手的软件,但仍具有一些高级功能(例如从外部源/表格链接文本,处理母版页/主题等) .

问候,奥斯卡

0 投票
6 回答
761 浏览

wiki - 将 Wiki 内容转化为系统手册的工作流程

我们正在为许多地方的许多用户(8 个国家/地区的 200 多个用户)部署一个新的软件系统。过去我们为用户编写了手册,然后每隔一段时间进行更新。这行得通,因为所有用户都拥有相同的手册,它涵盖了主要内容,但它也有问题,比如它不会经常更新,我们有时会错过更新,并且一些用户会有旧副本。

我们一直在讨论在测试和部署阶段使用 wiki 来构建有关系统的知识库。理想情况下,我们希望通过某种方式将其转换为某种形式的电子文档,然后我们可以“漂亮”并作为官方手册发送出去,并让用户使用和更新 wiki。

有没有其他人做过类似的事情?对 wiki 系统、工作流程、文档格式等有什么建议吗?

0 投票
3 回答
204 浏览

macos - 无法将所有 GNU Unix 手册与 Mac 中的所有 Unix 手册进行比较

我想通过 sdiff 比较所有 GNU Unix 手册和 Mac 的 Unix 手册。

例如,我不知道您如何浏览所有 Mac 的 Unix 手册,然后将它们保存到文件中。

当手册在两个文件中时,可以通过以下代码进行比较

也许,有一些 Unix 命令名称的索引,以便我们可以执行以下操作

您如何将所有 GNU Unix 手册与 Mac 中的所有 Unix 手册进行比较?

[编辑]

Mac 的手册位于 /usr/share/man/man[1-9]/*。当我尝试捕捉它们时,我遇到了它们的编码问题。

另一个问题是找到 Coreutils 手册的位置。

0 投票
2 回答
99 浏览

zsh - 无法为手册获取系统变量工作

我在 .zshrc 中有以下系统变量

我跑不成功

我明白了

该命令应与以下有效的命令相同

如何在 Zsh 中使用系统变量运行上述命令?

0 投票
1 回答
90 浏览

emacs - 无法在配置文件和手册之间快速移动

男士手册有以下内容

指定要使用的配置文件;默认为 /private/etc/man.conf。(参见 man.conf(5)。)

对于 man 中的 /private/etc/man.conf,PATH 以粗体显示。它建议我它可能是文件的超链接。有一个类似 Emacs 的人在里面移动会很酷。

我没有成功直接从手册中输入文件。

如何不在 man中执行以下操作,直接从 man 手册中获取文件?

0 投票
4 回答
204 浏览

emacs - 无法直接从终端在 Emacs 上打开手册

我想直接在终端中打开手册到 Emacs

我将以下代码作为别名放入 .zshrc 失败

如何打开 emacs 的手册?

0 投票
3 回答
4106 浏览

vim - 在 VIM 的普通模式下如何使用“K”按钮?

K 用于打开手册。我很感兴趣你如何使用它。你能用它来写各种手册吗,比如C、java和其他东西?

0 投票
2 回答
2730 浏览

makefile - $+ 在生成文件中

GNU makefile 中的 $+ 是什么意思?
另外,请给我一些很好的查找手册来编写makefile。

0 投票
3 回答
131 浏览

mysql - 无法将 MySQL 手册安装到 Mac

这个问题是基于线程的

我将手册下载为文件“v5.1 (Maria) TGZ”。我将文件移动到/usr/share/man/. 我无法通过以下方式访问手册

.tar.gz 文件包含这些不包含自述文件的文件


我将文件复制到 /usr/share/man/mysql。但是,我无法通过关键字访问手册mysql

我应该把文件放在哪里,以便 Man 可以访问它们?

如何将 MySQL 手册安装到 OS X Leopard?