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
Eight guidelines for plain sentences
Guideline 1: The subject of the sentence should be what the sentence is about.
Guideline 2: The subject should be the “doer” in the sentence.
Guideline 3: The verb should state the action, or what the doer is doing.
Guideline 4: The subject of the sentence should come early in the sentence.
Guideline 5: Eliminate nominalizations.
Guideline 6: Eliminate excessive prepositional phrases.
Guideline 7: Eliminate redundancy in sentences.
Guideline 8: Write sentences that are “breathing length.”
Four techniques for writing persuasively INCLUDING CHANGING THE PACE
At a Glance: Persuasive Style Techniques
* Elevate the tone.
* Use similes and analogies.
* Use metaphors.
* Change the pace.
Culturally deep = consultants
Culturally deep documents and interfaces use the language, symbols, and conventions of the target culture to reflect readers’ design preferences and expectations. To develop a culturally deep design, you probably need help from designers or consultants who are familiar with the target culture and understand its design expectations.
Culturally shallow documents and interfaces usually follow Western design conventions, but they adjust to reflect some of the design preferences of the cultures in which they will be used. They also avoid any cultural taboos of the people who are likely to use the text. Culturally shallow designs tend to be used in documents or interfaces that need to accommodate a variety of cultures.
Reasoning-based persuasion techniques INCLUDING COSTS AND BENEFITS
Persuading with Reasoning
Reasoning has two basic forms:
Reasoning with logic—Using logically constructed statements such as:
* if . . . then
* either . . . or
* cause and effect
* effect . . . because
* costs and benefits
* better and worse
Reasoning with examples and evidence—Using real or realistic statements, such as:
* examples
* prior experiences
* facts
* data
* observations
* quotes from experts
Five principles of design AND WHAT IS IN EACH
Balance—The document should look balanced from left to right and top to bottom.
Alignment—Images and words on the page should be aligned to show the document’s structure, or hierarchy.
Grouping—Related images and words should be placed near each other on the page.
Consistency—Design features in the document should be used consistently, so the document looks uniform.
Contrast—Items in the document that are different should look significantly different.
How to apply each principle:
Balance
* On a balanced page or screen, the design features should offset each other to create a feeling of stability. To balance a text, imagine your page or screen is balanced on a point. Each time you add something to the left side, you need to add something to the right side to maintain balance. Similarly, when you add something to the top, you need to add something to the bottom.
* When balancing a page or screen, graphic designers will talk about the “weight” of the items on the page. What they mean is that some items on a page or screen attract readers’ eyes more than others—these features have more weight. A picture, for example, has more weight than printed words because readers’ eyes tend to be drawn toward pictures. Similarly, an animated figure moving on the screen will capture more attention than static items. Here are some basic weighting guidelines for a page or screen:
* Items on the right side of the page weigh more than items on the left.
* Items on the top of the page weigh more than items on the bottom.
* Big items weigh more than small items.
* Pictures weigh more than written text.
* Graphics weigh more than written text.
* Colored items weigh more than black-and-white items.
* Items with borders around them weigh more than items without borders.
* Irregular shapes weigh more than regular shapes.
* Items in motion weigh more than static items.
* A time-tested way to devise a balanced page design is to use a page grid to evenly place the written text and graphics on the page. Grids divide the page vertically into two or more columns.
Alignment
* By aligning items vertically on the page, you can help readers identify different levels of information in a document.
* By aligning items horizontally, you can connect them visually so readers view them as a unit.
* In paper-based documents, look for ways you can use margins, indentation, lists, headings, and graphics to create two or three levels in the text.
Grouping
* The principle of grouping means that items on a page that are near each other will be seen as one unit. Grouping allows you to break up the information on a page by dividing the text into scannable blocks.
* Grouping is also referred to as “using white space” to frame items on the page. White spaces are places where no text or images appear on the page and include:
* the margins of the document.
* the space around a list.
* the area between an image and the body text.
* the space between two paragraphs.
* One way to group information is to use headings.
* In document design, borders and straight lines, called rules, can be used to carve a page into smaller groups of information. They can also help break the text into more manageable sections for the readers.
* Borders completely frame parts of the document.
* Rules are often used to highlight a banner or to carve a document into sections.
Consistency
* The principle of consistency suggests that design features should be used consistently throughout a document or website:
* Headings should be predictable.
* Pages should follow the same grid.
* Lists should use consistent bulleting or numbering schemes.
* Page numbers should appear in the same place on each page.
* A document should not use more than two typefaces.
* Graphics such as tables, charts, pictures, and graphs should be labeled consistently in your document.
* Decide how lists will be used and how they will look.
* If headers and footers appear at the top or bottom of each page, the document will tend to look like it is following a consistent design.
Contrast
* Contrast makes items look distinct and different, adding energy and sharpening boundaries among the features on the page or screen.
* There are a variety of ways to add contrast to a page, including:
* color
* shading
* highlighting
* changes in font sizes.