TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
- To open the document in Outline view, selectÂView > Outline.
If the context is clear, you do not need to write it.
In some cases they use option B;
- SelectÂUsers + groupsÂto open the blade.
We usually added a third level: Result.
So in the internal style guide of the user guide we had a kind of:
Topic (main topic in the head line)Explanation of the topic (plain text)
1. to do... click ...
Â ÂThe ... screen opens.
2. Enter the name,
Â Â The system checks whether the name is valid.
3. Click Save to save the values and close the window.
Â Â The system saves the record or rejects the values if they are not valid.
This is just a kind of hypothetical procedure.If the context is clear, you do not need to write it in the first place. ("Click save" explains itself, if you want to read more details, you can read the rest.)
It is possible to write "To save the record, click 'Save' ". But I think here it is better to write using option B.
The base stucture is:
context, step, result.
There is a contradiction you havve to solve:Often the context is the result. But it comes behind the handling.
I would use a kind of time driven style.And I would use a hierarchy, including head lines.
Best regardsBernd Am Samstag, 29. Dezember 2018, 01:47:24 MEZ hat Gene Kim-Eng <techwr -at- genek -dot- com> Folgendes geschrieben:
This lands squarely in the bin I call "pick one you like and stick with it."