Here are a few links I'm going to be looking at:
- Style Guides - https://www.writethedocs.org/guide/writing/style-guides/
- Style Guides for Technical Writers - https://medium.com/technical-writing-is-easy/style-guides-for-technical-writers-72b011f84c4b
- Developing a Departmental Style Guide - https://techwhirl.com/developing-a-departmental-style-guide/
What style guides have you used? What is your preferred "voice"?
For general text and instruction I like to try to keep the language in a directive or command form. "Add the LED to the circuit, connecting the Anode (+) to pin 3 of the 555 timer and the cathode (-) to ground", rather than "You can now add the LED to the circuit...."
I tend to favor more informal voice for "Note:" or "Pro Tips", where you use language and descriptions like "You will be more successful in this step if you...."
I would like to get your comments on what you have found to be successful, and if you have examples, please link them in the comments.
No comments:
Post a Comment