6
votes
4answers
429 views

How to categorise information in end-user documentation?

One of the greatest piece of documentation I ever read is the TeXbook by Donald Knuth—the manual of the TeX typesetting system, and I used it in my first analysis. As far as I can tell, the type of ...
5
votes
1answer
311 views

Which concepts are pertinent to plan a “end-user documentation” strategy?

I am writing a lot of software and I feel that writing good documentation is very difficult. Since I am not aware of any structured theory about software documentation I started to organise my ...
6
votes
2answers
143 views

How to keep user's guide in lockstep with branches for a non-developer?

Our current user's guide is built using asciidoc. The documentation is managed by a non-technical person, but we keep the source text files as well as generated HTML in source control. Issues arise ...
2
votes
3answers
935 views

Writing an (end-) user documentation [duplicate]

I am looking for (common / abstract) templates and examples for the (end user) documentation of software. I especially need something for an "Installation Guide", an "Operation Guide" (operation / ...
8
votes
5answers
2k views

Good references for End User documentation examples and advise [closed]

Our in house software has been used for many users and the training department asked us for any tips of end user documentation format. Does any know where can I find good examples of software end ...