yagni
When analyzing the purpose of a business document, what three audiences are we gonna deal with?
Experts, Managers, Operators
Why would this audience need the longer document?
Because they would need the jargon, and definitions of new unknown terms.
How does a purpose statement help narrow the amount of research that the document writer need to do?
Once you know the information the audience needs, then you know what exactly you will need to research
What order should we write a document?
Body first, conclusion to the body, then the introduction
When revising for organization, how much time do we expect to spend per page?
Four to six hours per page
How do experts use the information?
Experts want all the information in detail so they can give advice
When you are unsure of the audience's knowledge is, what should you do?
Contact them, and assess their knowledge with some basic questions about the information
To what level of detail should a document's outline be written?
One to two levels, the third level if you are working on super technical
What is the logical problem we encounter when we start with the introduction?
We are introducing something that isn't even there to be introduced
When revising for coherence, should we repeat keywords, or should we use unique words each time?
Repeat keywords to keep it concise
How do the operators use the information?
Operators are gonna follow instructions
When unable to contact the audience to determine the audience's knowledge level, what do we default to?
you should default to the high knowledge document
How many different audiences can a body of a document be written to? Why?
One, because what they are using it for is going to be different than another audience
At what point should we begin editing the document?
At the end of the drafting stage
What is the one verb tense all cultures share?
Present tense
How do managers use the information?
Managers want the business risk, and what the data means
Why do we default to the high knowledge?
You go to the shorter document because you can always add more information to it if there needs to be some extra clarification
What are some ways to accommodate more than one audience with a single document?
Write a separate documents, break the document into separate sections, have front and back matter
What is the Oxford comma?
Comes before the AND in a list
What are two tenses available for us to use in technical document writing?
Sometimes past, and present
Which type of audience would typically require the longer document?
An audience that has little to no knowledge
What are the five items found in a purpose statement?
Type of document, What it does, Info audience needs, Type of audience, What they should do with the information
Where should the main point of a document be? Why?
Beginning of the paragraph, first sentence. Managers just want to be able to skim through and not read everything on the page
When revising for content, how much time do we expect to spend per page?
Two to five minutes per page
What is the 10/20/30 rule?
No more than 10 slides, no longer than 20 minutes, and no smaller than 30 point font