manuals

Best Manual Editing Software

I'm writing a manual for our new software product... and M$ Word just doesn't cut it. So what is the best software or language to use for creating/editing a software manual? ...

PHP-Based Manual Apps

Are there any well-made web apps for writing tehcnical/API type manuals? I've got some code I want to write some "getting started" guides for and maybe some reference content. PHPDocumentor is all fine and good for documenting my class heirarchy, but I also want to put something together that is a bit more human readable and linear. I s...

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, HTML easy backup and deployment (so we can "deploy" to customers site as read only versi...

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

Hi, 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 for a novice to pick up but still has some advanced features (like linking in text f...

programming manuals on the web

Where do you go when you're stuck? Or even just lazy? I use these quite a bit: mysql sqlite sed xml libxml xslt docbook css css properties ...

Workflow to Turn Wiki content into a system manual

Hello, 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 the same manual and it covers the main things but it has it's problems, like it doe...

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 are in two files sdiff <(file1) <(file2) Perhaps, there is some index of Unix command...

How can I locally manage C manuals?

My Googling results in a huge amount of unnecessary results with C. My hope is to get the best C manuals local. I find the reference useful here. I would like to make my own notes and removal to the manual. Can I manage it somehow like a local manual? Feedback to the repliers worried about the law Please, read this post about so...

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 command which works zgrep -c compinit /usr/share/man/man<1-9>/zsh* How can you run the ...

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 would be cool to have a Emacs-like moving in man. I have not succeeded to enter the f...

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? ...

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? ...

$+ in makefile

What does $+ in a GNU makefile mean? Also, please give me some good lookup manual for writing makefiles. ...

Unable to install MySQL manuals to Mac

This question is based on the thread. I downloaded the manuals as the file "v5.1 (Maria) TGZ". I moved the file to /usr/share/man/. I could not access the manuals by man mysqlbug The .tar.gz -file has these files which do not include README comp_err.1 innochecksum.1 make_win_bin_dist.1 msql2mysql.1 my_print_defaults.1 myisam_ftdump....

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 not about whether I should or should not use Framemaker - that is the software I have to ...

Asp.net MVC introduction

Where can I find some asp.net MVC introduction articles/tutorials. ...

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 my way around is difficult, and I don't see any man pages. UPDATED with the official Rock...

Easing/Automating the Creation of Manuals, Web Pages, Packages, etc. for Public Release

Hi, I have no problem creating software. I have dozens of projects that I would be more than happy to release to the public. The problem is that after I put the finishing touches on something (eg final release build), I end up blocked because it’s not as simple as just putting an EXE on the Internet for people to download. I have diffic...

some literature about structure of social networks

Can you advise some literature about structure of social networks? I am interested in building databases of social networks. Sorry for bad English. ...

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 googling I observed that most tutorials where using it a lot. I would prefer using it but on...