Foundation-Focused Deck Flashcards
Four levels of edit (R,SE,C,P) & EXACTLY WHAT EACH LEVEL CONTAINS
- Revising (SPRC)
- Substantive Editing (COD)
- Copyediting (SPHG)
- Proofreading (GPSW)
The Four Levels of Edit:
Level 1: Revising—Revises the document as a whole, which is why this level of edit is often called “global editing.” Revision pays attention to the document’s subject, purpose, readers, and context of use.
Level 2: Substantive Editing—Pays special attention to the content, organization, and design of the document.
Level 3: Copyediting—Concentrates on revising the style for clarity, persuasion, and consistency, especially at the sentence and paragraph levels. (and headings and graphics)
Level 4: Proofreading—Catches only the grammatical mistakes, (punctuation), spelling and typos, and word usage problems.
Five stages of the technical writing process IN ORDER
Stage 1: Researching and Planning
Stage 2: Organizing and Drafting
Stage 3: Improving the Style
Stage 4: Designing
Stage 5: Revising and Editing
Stage 1: Researching and Planning
1. Research your topic
2. Define your purpose
3. Develop a profile of your readers
4. Tap into your creative side
5. Devise your strategic plan
Start-Up Research - internet searches
Formal Research - electronic, print, and empirical sources
Profiles - Needs, Values, Attitudes
Creative side - concept mapping, brainstorming lists, freewriting, storyboarding; what changed recently?
Planning:
1. Identify your objective(s)
2. Create a task list
3. Create a project timeline
Stage 2: Organizing and Drafting
* Choose a genre
* Generate your first draft
Stage 3: Improving the Style
* Plain style - clarity and accuracy
* Persuasive style - motivates by appealing to physical senses, personal values, and emotions
* use sensory details
* use similies and metaphors
* use tone and pace
Stage 4: Designing
* highlight important ideas and facts
* use effective graphics and layout
Stage 5: Revising and Editing
A well-edited, error-free document will help build your readers’ trust in your ideas
1. Level 1: Revising—Subject, purpose, what readers need to know
2. Level 2: Substantive editing—Content, organization, design
3. Level 3: Copyediting—Sentences, paragraphs, graphics
4. Level 4: Proofreading—Grammar, typos, spelling, usage mistakes
Four type of readers (PSTG/Ac,Ad,Ev,Su)
SECONDARY/ADVISORS ARE EXPERTS, TERTIARY/EVALUATORS HAVE AN INTEREST
Types of Readers:
- Primary readers: Action takers: decide/do something
- Secondary readers: Advisors: experts, influence
- Tertiary readers: Evaluators: interested outsiders
- Gatekeepers: Supervisors: sign off before send to primary readers
Four contexts of document use (PMEE)
- Physical context
- Mobile context
- Economic context
- Ethical context
Four aspects of a document to adjust for global audiences (COSD)
- Content
- Organization
- Style
- Design
Eight steps for researching in technical workplaces - STEPS IN ORDER
- Define your research subject.
- Formulate a research question or hypothesis.
- Develop a research methodology.
- Collect evidence through print, electronic, and empirical sources.
- Triangulate your sources.
- Take careful notes.
- Appraise your evidence.
- Revise, accept, or abandon your hypothesis.
Three kinds of evidence for solid research AND EXAMPLES OF EACH
Solid research draws from three kinds of evidence:
Electronic sources: Websites, DVDs, research databases, image databases, television and radio broadcasts, sound recordings, videos, podcasts, blogs
Print sources: Books, journals, magazines, newspapers, government publications, atlases, reference materials, microform/microfiche, press materials, pamphlets
Empirical sources: Experiments, surveys, interviews, field observations, ethnographies, case studies, archives
Dangling modifier DEFINITION AND EXAMPLES
A dangling modifier is a modifier (usually an introductory phrase) implies a different subject than the one in the sentence’s subject slot. A dangling modifier occurs when a phrase does not properly explain the subject.
Examples:
While eating lunch, the acid boiled over and destroyed Lisa’s testing apparatus.
After driving to Cleveland, our faithful cat was a welcome sight.
Copyediting marks / editing symbols - INCLUDING ADD PERIOD
insert
delete
close up space
insert space
transpose
capital letters
lowercase
lowercase, several letters
italics
boldface
delete italics or boldface
normal type (roman)
add period
add comma
add colon
add semicolon
add quotation marks
add apostrophe
begin new paragraph
remove paragraph break
indent text
move text left
block text
spell out (abbreviations or numbers)
See graphic on page 542.
Four types of sentences
- Transition sentence
- Topic sentence
- Support sentence
- Point Sentence
Transition sentence - make a smooth bridge from the previous paragraph to the present paragraph
Topic sentence - the claim or statement that the rest of the paragraph is going to prove or support
Support sentence - The bulk of any paragraph is typically made up of support sentences. These sentences contain examples, reasoning, facts, data, anecdotes, definitions, and descriptions.
Point Sentence - restate the paragraph’s main point toward the end of the paragraph
Four advantages of documenting your sources
Documenting your sources offers the advantages of:
- supporting your claims by referring to the research of others.
- helping build your credibility with readers by showing them the support for your ideas.
- reinforcing the thoroughness of your research methodology.
- allowing your readers to explore your sources for more information.
Six moves in an introduction
Move 1: Define your subject.
Move 2: State your purpose.
Move 3: State your main point.
Move 4: Stress the importance of the subject.
Move 5: Provide background information.
Move 6: Forecast the content.
Five moves in a conclusion - INCLUDING RESTATE YOUR MAIN POINT
Move 1: Make an obvious transition.
Move 2: Restate your main point.
Move 3: Reemphasize the importance of the subject.
Move 4: Look to the future.
Move 5: Say thank you and offer contact information.
The Given/new method tp write plain paragraphs
Every sentence in a paragraph should contain something the readers already know (the given) and something that the readers do not know (the new).
Three links MAX to a website’s most important information
How many levels should a website have? Professional website designers use the following guidelines to determine the number of levels needed in a website:
* A maximum of three links for the most important information
* A maximum of five links for 80 percent of all information
* A maximum of seven links for all information
Where do splash pages appear in a website?
Before home page
From Google:
A splash page is an introductory web page that users see before they can continue on to the main content of a website. Splash pages are also known as landing pages or splash screens.
(Technical Communication Today, Sixth Edition [2018] does NOT mention splash or landing pages or screens.)
Benefits of an outline
Sometimes it helps to sketch an outline before you start drafting. That way, you can see how the document will be structured.
For all genres, outlining is a good way to start sketching out the shape of your document. Outlining may seem a bit old-fashioned, but it is very helpful when you are trying to sort out your ideas, especially as you prepare to write a complex technical document.
Your outline can be a helpful tool for planning, drafting, and revising your work, whether you sketch your ideas out on paper or with presentation software.
Concept mapping, brainstorming, freewriting, outlining/boxing, and the Five W and How questions are good ways to generate new ideas.
Outlining may seem old-fashioned, but it is a very effective way to sketch out the organization of a document.
Body of a Brief Report
- Summary of completed activities
- Discussion/results of ongoing activities
- Forecast of future activities
- Expenses
Body of a Formal Report
IMRaD (Introduction, Methods, Results, and Discussion)
- Methodology
- Results
- Discussion