19
votes
Accepted
Preferred word for "preferred", "target", "chosen" in end user support documentation
One possibility is to not use the adjective: "Select a printer".
Another is to use the adjective appropriate to the action: Sometimes you mean "Select a disk", sometimes (like for formatting) you ...
- 100k
16
votes
Accepted
Instruction manuals: should the end-user be addressed directly (passive vs imperative)?
Use direct, simple, clear, imperative instructions.
Passive voice and subjunctive make your language unclear and complicated for an international audience. Luckily in this respect there is no ...
- 554
10
votes
Preferred word for "preferred", "target", "chosen" in end user support documentation
All instructions writers wrestle with these terms. Just remember that instructions should be absolutely clear, without ambiguity. "Preferred" can be ambiguous. Does a "preferred" printer stay that way?...
- 1,323
8
votes
Accepted
Format keyboard keys in documents
I am assuming that your organization does not have an official style guide, or that this is a personal project. (If you are bound by a style guide, consult it.) I am also assuming that you aren't ...
- 21.4k
7
votes
Instruction manuals: should the end-user be addressed directly (passive vs imperative)?
Passive voice gets a bad reputation. We're taught to avoid it at all costs. For the most part that's correct, too. It's dull, slows the sentence, and is often vague. If you're writing end user ...
- 389
5
votes
Accepted
Should user manuals be organized by feature or process?
In most cases, I think, it is best to organize an end-user manual by process because this is what the user cares about. When they use the software they will begin with the first step of their workflow ...
- 663
4
votes
Should user manuals be organized by feature or process?
I will echo Matt in suggesting that the process orientation is the best approach.
However, let me propose a hybrid approach. The software might support multiple processes and those processes might ...
- 5,247
4
votes
Formatting of Text in Technical Writing (Procedure Writing)
These are style questions and mostly a matter of opinion; but if the matching is intended to help the user recognize the key, then if I were writing a manual I would match the italics, and if possible ...
- 100k
4
votes
Formatting of Text in Technical Writing (Procedure Writing)
Typically in documentation you would want every UI reference to be styled consistently. This would lead me to think that matching font styles to individual elements is not the ideal approach.
Best ...
- 123
2
votes
In end user documentation, should screenshots come before or after the text that references them?
Screenshots can also come to the right or left of text that references them. Using columns can improve readability and keep illustrations from being separated across pages from the text that ...
- 1,323
2
votes
Should user manuals be organized by feature or process?
Why not both?
In the Olden Days™, software would often come with two sorts of documentation:
A tutorial or user guide, explaining how to perform common tasks. This could be anything from a quick ...
- 671
1
vote
Accepted
What are the conventions for formatting links to two API references in software user guide text?
So a common technique I have found is for online or digital documentation, to offer the information for the different languages as a selectable dropdown or tabbed panel in some way. Either as a tabbed ...
- 1,141
1
vote
Instruction manuals: should the end-user be addressed directly (passive vs imperative)?
Recently, my favorite documentation style is the one promoted by the Pragmatic Bookshelf, a major technical publisher. The PB authors must structure their books as conversations with their prospective ...
- 383
1
vote
Demo data in screenshots! What are the best practice?
You can use Sherlock Holmes, since he is a public domain fictional character and he has a famous fictional address. I think this adds a little fun but not so much that it is distracting, and it feels ...
- 1,348
Only top scored, non community-wiki answers of a minimum length are eligible