Home Page Icon
Home Page
Table of Contents for
Half-Title Page
Close
Half-Title Page
by Carrie Marshall
Technical Writing for Business People
Front Cover
Half-Title Page
BCS, THE CHARTERED INSTITUTE FOR IT
Title Page
Copyright Page
Contents
List of figures
Author
Preface
1. What is Technical Writing?
The technical writer’s toolkit
The most important thing you need as a technical writer
Key takeaways
2. Seven Steps to Heaven: the Technical Writing Cycle
1. Specification, audience and scope
2. Planning
3. Research and writing
4. Testing, reviewing and revision
5. Delivery
6. Evaluation and feedback
7. Revision, archiving or destruction
Technical writing in a team
A quick word about writing apps
A quick word about formatting text
Key takeaways
3. Know Your Audience
Who are you writing for?
Personas in technical writing
What do they already know?
What do they need to know, and why?
Where and when do they need to know it?
Key takeaways
4. Break it Down: the Importance of a Task-based Approach
Break it down (but not too much)
The other big benefit of a task-based approach
Key takeaways
5. Assume Nothing
Making assumptions
Assumptions and accessibility
Junk the jargon, banish buzzwords and abolish acronyms
Key takeaways
6. Vanquish Vagueness
Be precise
Don’t leave wiggle room
Be specific
Key takeaways
7. Don’t be Yourself
The importance of clarity
Key takeaways
8. Stick to the Story
1. Long paragraphs
2. Dense blocks of text
3. Irrelevant or useless graphics
4. Poor punctuation
5. Too much information
6. Forgetting to include the ‘how’
7. Unclear navigation aids
Key takeaways
9. be Active: Why You should Avoid the Passive Voice and Weak Verbs
Why weak words make writing worse
Key takeaways
10. Diagrams, Lists and Graphics
Listy business
Go with the flow (chart)
Other kinds of charts
Keep away from the clipart
Good graphics
Key takeaways
11. Everybody Needs an Editor
Let go of your ego
What to look for when you’re editing
Accuracy
Simplicity
Brevity
Effectiveness
Sheer tedium
Key takeaways
12. the Technical Writing House of Horrors
When commas cost
The conversion that cost a spaceship
The ‘s’ that killed a company
When xxx costs $$$
The £52 million comma
Afterword
Index
Search in book...
Toggle Font Controls
Playlists
Add To
Create new playlist
Name your new playlist
Playlist description (optional)
Cancel
Create playlist
Sign In
Email address
Password
Forgot Password?
Create account
Login
or
Continue with Facebook
Continue with Google
Sign Up
Full Name
Email address
Confirm Email Address
Password
Login
Create account
or
Continue with Facebook
Continue with Google
Prev
Previous Chapter
Front Cover
Next
Next Chapter
BCS, THE CHARTERED INSTITUTE FOR IT
Add Highlight
No Comment
..................Content has been hidden....................
You can't read the all page of ebook, please click
here
login for view all page.
Day Mode
Cloud Mode
Night Mode
Reset