Stack Overflow
Stack Overflow

Questions tagged [manuals]

18 questions
39
votes
11 answers

Application (Not a Markup Language) for Producing a User Manual

Can anyone recommend a program to create user manuals with? Not a markup language (like LaTeX or DocBook) but more something interactive like Scribus. As I'm not the only one that will update the manual the software should be something that's easy…
finnsson
  • 4,037
  • 2
  • 35
  • 44
36
votes
17 answers

What tools does your team use for writing user manuals?

Basic requests are: human readable / text format (for easy version control) online (for collaboration) easy formatting (markdown ok, html is too much) strict formatting (so authors don't invent new types of titles, bullets etc.) exportable to PDF,…
David Vidmar
  • 3,042
  • 6
  • 29
  • 35
15
votes
12 answers

Using the word "you" in an user manual

I am writing a user manual and I have come to a discussion with a colleague. He says I cannot use the word "you" anywhere in the manual. Now I remember something about this at school but that was not for writing procedures. Also, doing some…
yan bellavance
  • 4,710
  • 20
  • 62
  • 93
13
votes
3 answers

How do you use the "K"-button in the normal mode of VIM?

K is used to open manuals. I am interested how you use it. Can you use it to all kind of manuals, such as C, java and other things?
Léo Léopold Hertz 준영
  • 134,464
  • 179
  • 445
  • 697
9
votes
2 answers

UniVerse learning materials

I've recently come in contact with a proprietary descendant of UniVerse. Does anyone know where I can get a good tutorial or brush up on the syntactic quirks of its more popular parent? I can't figure out how to even get a table listing. Navigating…
Evan Carroll
  • 78,363
  • 46
  • 261
  • 468
4
votes
6 answers

Workflow to Turn Wiki content into a system manual

We're in the middle of deploying a new software system to lot's of users in lot's of places (200+ users over 8 countries). In the past we've written a manual for the users, then update it every so often. This works ok, in that all the users ahve…
PaulHurleyuk
  • 8,009
  • 15
  • 54
  • 78
4
votes
2 answers

Manual pages for Ruby functions from command line

Is there a way to get at the manuals of Ruby functions from the command line? Like the ?func man pages in R.
Aleksandr Levchuk
  • 3,751
  • 4
  • 35
  • 47
4
votes
2 answers

Ada manuals: difference between annotated and consolidated

what's the difference between the Consolidated Ada Reference Manual 2005 Edition (ISO/IEC 8652:2007(E), Ed. 3) from Springer and the Annotated Ada Reference Manual (ISO/IEC 8652:1995(E)) 2005 Edition? The Annotated Ada Reference Manual is marked as…
yCalleecharan
  • 4,656
  • 11
  • 56
  • 86
3
votes
1 answer

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…
Shenoy Tinny
  • 1,315
  • 10
  • 22
  • 34
2
votes
2 answers

Looking for free tool or template to generate an online user's guide for web-based system

I am looking for a a free template or tool to help creating an online user's guide (manual) for a web-based system. I have been searching on the web for hours and just found some expensive commercial solutions with too many functionalities. I am…
user430830
2
votes
2 answers

How to format source-code in a Framemaker document?

I have to write up a technical document in Framemaker that explains various programming source-code. So my document consists of a bunch of text, followed by a bunch of source code (Java, XML) and then followed by more text, etc. This question is…
po.
  • 23
  • 3
1
vote
3 answers

Unable to compare all GNU Unix manuals with all Unix Manuals in Mac

I would like to compare all GNU Unix manuals and and Mac's Unix manuals by sdiff. I do not know how you go through, for instance, all Mac's Unix manuals and then save them to a file. The comparison can be done by the following code when the manuals…
Léo Léopold Hertz 준영
  • 134,464
  • 179
  • 445
  • 697
0
votes
4 answers

Unable to put manuals open at Emacs directly from terminal

I want to open manuals directly in Terminal to Emacs by man man I put the following code as an alias in .zshrc unsuccessfully alias man=x unalias man man() { emacs ^x man } How can you open manuals to emacs?
Léo Léopold Hertz 준영
  • 134,464
  • 179
  • 445
  • 697
0
votes
1 answer

Unable to move fast between config files and manuals

Man's manual have the following Specify the configuration file to use; the default is /private/etc/man.conf. (See man.conf(5).) The PATH is in bold for /private/etc/man.conf in man. It suggests me that it could be a hyperlink to the file. It…
Léo Léopold Hertz 준영
  • 134,464
  • 179
  • 445
  • 697
0
votes
2 answers

Unable to get a system variable work for manuals

I have the following system variable in .zshrc manuals='/usr/share/man/man<1-9>' I run unsuccessfully zgrep -c compinit $manuals/zsh* I get zsh: no matches found: /usr/share/man/man<1-9>/zsh* The command should be the same as the following…
Léo Léopold Hertz 준영
  • 134,464
  • 179
  • 445
  • 697
1
2