问题标签 [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 投票
2 回答
872 浏览

documentation - 如何在 Framemaker 文档中格式化源代码?

我必须在 Framemaker 中编写一份技术文档,解释各种编程源代码。

所以我的文档由一堆文本组成,然后是一堆源代码(Java、XML),然后是更多的文本,等等。

这个问题与我是否应该使用 Framemaker 无关——这是我必须使用的软件。. .

我感到困惑的是如何将源代码格式化为我的文档的一部分。有没有人为技术文档这样做并遇到任何说明或提示?到目前为止,我的谷歌搜索还没有产生任何与我需要做的事情相关的内容。

0 投票
2 回答
4707 浏览

u2 - 宇宙学习资料

我最近接触到了 UniVerse 的专有后代。有谁知道我在哪里可以获得一个好的教程或复习其更受欢迎的父级的语法怪癖?我什至不知道如何获得表格列表。导航很困难,而且我看不到任何手册页。

使用官方 Rocket Software 链接更新:

需要特别注意SQL ReferenceSQL Administration for DBAsUser Reference。在这两个页面的底部还有一个指向包含所有文档的 zip 的链接。Universe 10.3 还有一个关于 Rocket Software 的演示(需要个人信息),但它仅适用于 RHEL。而且,即使它是静态链接的,它也会在我使用 Ubuntu 8.10 时出现段错误。

这些链接来自 Rocket Software(Uni* 系列产品的当前所有者)的官方链接

这是 Rocket Software 收购产品线之前的一个:

0 投票
12 回答
16222 浏览

documentation - 在用户手册中使用“你”这个词

我正在编写用户手册,并与一位同事进行了讨论。他说我不能在手册的任何地方使用“你”这个词。现在我记得在学校关于这件事的一些事情,但那不是为了编写程序。此外,通过谷歌搜索,我发现大多数教程都大量使用它。我更喜欢使用它,但前提是这被认为是好的做法。你怎么看?

0 投票
2 回答
182 浏览

ada - Ada 手册:注释和合并之间的区别

Springer 的 Consolidated Ada Reference Manual 2005 Edition (ISO/IEC 8652:2007(E), Ed. 3) 和 Annotated Ada Reference Manual (ISO/IEC 8652:1995(E)) 2005 Edition 有什么区别?Annotated Ada Reference Manual 标记为 Draft 16。如果我理解正确,合并版是注释版的最终版本。我对吗?

非常感谢...

0 投票
1 回答
271 浏览

html - How to write marketplace web project documentation?

When creating web projects (mostly XHTML/WORDPRESS THEMES) for sale on any given marketplace, what is the best way to go about writing technical manuals for users?

0 投票
2 回答
392 浏览

documentation - 技术手册编辑/出版/在线协作

我们有多种软件产品,每种都有 6 种语言的手册。

我们需要与想要贡献/编辑手册的用户合作。

我们希望对手册进行非常用户友好的在线演示。理想情况下,我们希望从适合打印的手册中生成精美且高质量的 PDF。

有没有在线工具可以做到这一点?我们一直在尝试与 mediawiki 合作,但它不是一个理想的解决方案,也不是真正用于制作手册的。

0 投票
2 回答
1013 浏览

ruby - 命令行中 Ruby 函数的手册页

有没有办法从命令行获取 Ruby 函数的手册?

就像?funcR 中的手册页一样。

0 投票
2 回答
2528 浏览

eclipse - 寻找免费工具或模板来生成基于 Web 的系统的在线用户指南

我正在寻找一个免费的模板或工具来帮助创建基于 Web 的系统的在线用户指南(手册)。我已经在网上搜索了几个小时,只是发现了一些功能太多的昂贵的商业解决方案。

我正在尝试创建类似http://help.eclipse.org/helios/index.jsp的东西。刚刚检查了 eclipse 有一个,但似乎只能在 eclipse RCP 项目上使用。

您知道此任务的任何免费工具或模板吗?我真的很感激任何帮助。

非常感谢,蒂亚戈

0 投票
1 回答
427 浏览

plugins - Is there a grails plugin to create an online documentation guide?

I am developing a grails app and was wondering if there is any grails plugin available to create online manuals in both HTML and PDF version, something like:

  • Spring's reference docs which is hosted in both html and pdf versions.
  • Yahoo! PlaceFinder webservice guide

If there is not one available, can you please advise me on the tools that can be used to accomplish this.

The documentation is to be used by general public.