English 303 Rubric. Rubric Overview. Writing Corrections Instructions. Accessibility Errors
|
|
- Buck Boone
- 5 years ago
- Views:
Transcription
1 Rubric Overview Recall that an "A" paper is excellent. It is difficult to improve. It is submitted on time and demonstrates insight, originality, and attention to detail. It adheres to American English grammar and usage. It follows the assignment s formatting requirements exactly. The information is presented ethically, comprehensively, and clearly in an easy and persuasive manner. Points are taken off until 50 percent of the total grade is reached unless the memo or paper meets the criteria for zero points (see the last section of this rubric for more information). Each minor error costs one percent of the total grade; however, one minor error per page is allowed without penalty. Each major error costs four percent; no major errors are allowed or ignored. Thus, for a 50-point memo, each minor error costs a half point and each major error costs two points. For a 300-point white paper, each minor error costs three points and each major error costs twelve points. Some errors fit into two categories and thus will count off twice; usually, these are grammar errors that affect clarity. Some errors are so serious that they can fail an assignment on their own. These are listed at the end of this rubric. Writing Corrections Instructions To improve your writing, you must learn to fix the mistakes you are making so that you will not continue to commit the same errors. The codes I wrote on your assignment correspond to the error explanations below. They are not full explanations; those you can find in the Style Guide or in Merchant s English Usage Guide for Technical Writers linked on Moodle. Both have extensive indexes to help you find the explanations; I tried to use the same wording in the rubric. Any paragraph or section that has errors will have the errors indicated by the codes below; you will need to review the paragraph to find and correct the errors for a few additional points (30 points for the definition memo, 5 points each for the rest). Because of time constraints at the end of the quarter and because the white paper is essentially a final exam, writing corrections only applies to the memo of intent, definition, progress report, and the two graphics assignments (which are both written as memos) no others. Complete instructions, including how to format the writing corrections sheet, are in the writing corrections instructions posted on Moodle as well as my Wordpress site. Accessibility Errors All information need to be in the appropriate section, organized logically; the document needs to be easy to navigate, making information quick to find by skimming or scanning readers. ACC 1. Major Errors A. Heading Level Errors A heading level is inconsistently formatted, confusing the hierarchical structure (for example, a level-1 heading formatted as a level 1 in some parts of the document and formatted as a level 2 in other parts). Each heading level is graded separately, so this can compound quickly.
2 Merchant page 2 A required heading for a level is missing. B. Illustration/visual not numbered C. Memo line incorrect (Memo of Intent for an Extended Definition memo, for example). D. Page Numbers/Numbering Errors All page numbers are not numbered as required (including different pagination schemes for the front matter and body of a white paper or technical report). All page numbers are missing from a memo or all page numbers are missing from a white paper s front matter. Note: A white paper missing all page numbers from the body or all page numbers are the same number will earn a failing grade. E. Ordering of Information Glossary not listed alphabetically. Information is not in the appropriate section of the memo, paper, or report. List information not organized logically. References not listed alphabetically. Table rows or columns not organized logically. List of Illustrations/Figures/Tables are not in the order they appear in the report. F. Table of Contents/Illustrations/Figures/Tables Errors List of illustrations/figures/tables does not match up with the document. List of illustrations/figures/tables missing. Table of contents does not match up with the document. Table of contents missing. ACC 2. Minor Errors A. Individual Page Number Errors A page number is missing (some or most pages are numbered); each missing number is one error up to 3 times; after that, it is a major error. A page number is incorrect (wrong page number; some or most pages are numbered correctly); each incorrect number is one error. B. Ordering of Information Most items in a list (glossary, list, references, etc.) are organized logically with less than four items in that list not in order (for example, most references are in alphabetical order but two are not); each item not in order counts as a minor error. After three, the error becomes a major error. Each list is treated separately. Clarity Errors Writing needs to flows smoothly and logically between ideas. The writer s meaning must be clear. CLA 1. Major Errors A. Color use in visuals (using color as your only indicator of emphasis or importance). B. Confused or contradictory language. I have read the passage three times and I still do not understand what you are trying to say. C. A crucial transition is missing. D. Illustration/visual errors (note: not indicating source of a visual can fail a paper by itself) Important features not noted.
3 Merchant page 3 Not captioned (titled). Not clear (confusing or difficult to read). Not integrated, including not introduced first. E. Vague Phrases Errors: And/or. Unsupported statements. F. Vague pronoun reference where it is impossible to tell by context what the pronoun s antecedent is (also counts as a major Correctness: Grammar and Punctuation error). G. Paragraphs are not organized in a smooth, logical manner in a page. CLA 2. Minor Errors A. A cliché or cultural, religious, or sports analogy is used (unless pertinent to your topic). B. Language is not clear enough to be understood with one reading. I had to read the passage twice to understand what you are trying to say. C. A quotation is floating or standalone. D. Sentence is awkward- could be written more clearly or to be read more easily. E. Unexplained terminology. F. Unnecessary archaic language (archaic word or using an archaic definition of a word), jargon, or slang. G. Unsure language ( I believe, may, etc.) used to support your thesis; such language makes you sound like you are not sure of what you are saying and robs your writing of its power. Such words lead to wishy-washy writing. Clearly support your arguments and clearly support your recommendation. But do not talk down to your audience. H. Two paragraphs need a transition to make your points easy to follow. I. Weak or missing topic sentence. J. Sentences not organized in a smooth, logical manner in a paragraph. Comprehensiveness Errors The writer must have a thorough understanding of audience, purpose, and context: everything (and no more) that the readers need must be present. Leaving out a required section can automatically fail a paper; exceptions (some are just major errors) are noted below. COM 1. Major Errors A. Executive summary too short; it leaves out information required by your audience (white paper or technical report). B. Memo heading segment or paper title page are directed to the wrong audience, or (for memos) use the wrong CC: or Through: (using CC: instead of Through: for example). C. Memo or paper could use more useful visuals. D. Memo or paper shows a lack of understanding of audience, purpose, or context. For example, you may need to fil in the necessary background so that someone who does not know the issue at hand will still be able to understand. Do not talk down to your audience, but be sure to provide the necessary details so that reasonably educated people are not confused. E. Missing contact information in instructions or memo or contact information is incorrect. F. Missing glossary.
4 Merchant page 4 G. Required visual is missing (each missing visual counts as a major error) H. Weak analysis, justification, or support for the recommendation. You are not thinking deeply enough; your writing relies too much on reporting your research material instead of a thoughtful analysis of those materials. You either just repeated an earlier point (or points) you made, given strong/off-topic analysis that does not really connect to your thesis (topic), or you gave shallow analysis (equivalent to a Wikipedia article). COM 2. Minor Errors A. Abstract too long (white paper or technical report), containing either too much filler/fluff or information your expert audience does not need. B. Keywords missing (abstract in a white paper or technical report). C. Purpose statement missing (memo). D. Sentence needs more information: may leave reader with an unanswered question that should be answered in that sentence (sometimes you can raise a question that then takes time to answer, that is OK); for example while both are useful, I researched only one. (The writer then moves on to another topic without ever saying which one they researched and the reader now wonders, which one?) E. A visual is added only for decoration or adds unneeded information. Conciseness Errors Writing needs to be tight, concise. Paragraphs mostly should not exceed six lines. Remember that in technical writing you need to have your paragraphs tightly focused. CON 1. Major Errors A. An average of two long paragraphs (more than six sentences) per page is acceptable each long paragraph over that average is a major error. That is, if your document is three pages long, you can have six long paragraphs before points are deducted. B. An average of two unnecessary complex sentences per page is acceptable each complex sentence over that average is a major error (each counts off three points). CON 2. Minor Errors A. A doubled word or redundant acronym. B. Expletive at the beginning of a sentence. C. In order that or in order to phrase. D. No more than an average of two long paragraphs (more than six sentences) per page. E. Of (to) the fact phrase. F. Other wordy expression or sentence (not covered by any of the other errors listed here). G. Unnecessary modifier (overused or redundant). H. Unnecessary relative clause. I. Use of fancy diction (see Merchant s English Usage Guide for Technical Writing for more information). J. Wordy phrase when a simpler word will do just as well. K. Wordy indefinite quantifier phrase.
5 Merchant page 5 Correctness: Grammar and Punctuation Errors Technical writing requires effective syntax and grammar, demonstrating a mastery of writing conventions. COR-G 1. Major Errors Major errors are costly so use spell check, go to the Writing Center, have someone help you with peer editing on a regular basis (a peer-editing buddy), and use writing aids listed on my WordPress site (davidmmerchant.com/writing-help/) including the English Usage Guide (davidmmerchant.com/merchants-english-usage-guide-for-technical-writers/). A. Abbreviation, Acronym, Initialism, and Contraction Errors Abbreviation, acronym, or initialism is not clearly spelled out or defined; they are overused (use only if the reader is familiar with the abbreviation and that you are using it more than once in a short document or more than two times in a long document). Contraction (do not use contractions unless quoted material has them). Social media abbreviation or symbol use. B. Absolute or Hyperbole Error C. Article use (missing). Too many article errors can fail a memo or paper. D. Comma Error Comma needed after an introductory clause, phrase, or word. Comma needed before the coordinating conjunction in a compound sentence (except for while which is a minor comma error). Comma-splice. A serial comma is missing where required. E. Faulty Modifiers (webapps.towson.edu/ows/moduledangling.htm) Dangling modifier. Misplaced adjective. Misplaced adverb. Misplaced clause or phrase. Misplaced modifier. F. Grammar Errors Other A confusing double negative An incorrect phrase (for example, I could care less or one in the same ). An incorrect preposition, one that changes the meaning of the sentence. An incorrect verb tense. Subject-verb agreement error. A word is missing from the sentence. G. Major Sentence-Level Errors Fragment. Run-on or fused. H. Number/Numbering Errors Billion or trillion. Date.
6 Merchant page 6 Format. Punctuation. Range. Spelling out. I. Pronoun Errors Pronoun-antecedent agreement. A pronoun must agree with its antecedent in gender, person, and number. Most of these errors are fixed by turning the antecedent into a plural form to match a plural pronoun. Pronoun case (subject, object, possessive). Pronoun shift. Vague pronoun reference) where it is impossible to tell by context what the pronoun s antecedent is (also counts as a major Clarity error). J. Punctuation Errors Apostrophe Plural. Possessive. K. Punctuation Errors Other COR-G 2. Minor Errors Minor errors can add up quickly, so you still need to be careful and limit how many you make. Use the advice given above for avoiding major errors to lessen how many minor errors you have. A. Abbreviation, Acronym, or Initialism Errors Abbreviated form is used only once even though it is also spelled out. Do not use the abbreviated form if used only once; spell it out. However, if your audience is more familiar with the abbreviated form, you can spell out the term as well as give the abbreviated form. For example, a paper written for a space industry will be familiar with the initialism NASA. In that case, the initialism can be used. Abbreviated form used in a paper title unless the audience is familiar with the abbreviated form. Etc. overuse. Latin abbreviation (e.g., i.e., or NB). [sic] not enclosed in brackets or sic not italicized. Punctuation. B. Article use (incorrect use). Too many article errors can fail a memo or paper. C. Grammar Errors Other Adjective agreement error (for example, this containers ). Anthropomorphizing machinery. Double negatives. For example, while not unnecessary is not confusing, it does take more effort to read than necessary. Ending a sentence with a to be verb. (You should try to avoid ending a sentence with to be verbs as this creates a too-casual tone for formal writing.) Numbers (spelling out, not spelling out, etc.) Parallelism. Passive voice. (Not all passive voice constructions are wrong; see Merchant s English Usage Guide for Technical Writers for more information.) Plural issues not created by apostrophe error (for example: type of switches
7 Merchant page 7 should be types of switches. Split Infinitive: too many words between to and the verb. Subjunctive Mood. Tense shift. Needless verb tense shifting confuses your reader and is an unpleasant distraction. Verb errors not covered by any of the above. D. List Errors List items syntactically part of a sentence punctuation error. Ordered list with no introductory explanatory text (explaining the order). Punctuation error with text introducing a list. E. Preposition Errors (not the correct preposition; however, while awkward, distracting, or odd choice, does not change the meaning of the sentence). F. Pronoun Errors Either or neither. Incorrect use of you. Overuse of I. Overuse of it or this (sentence could be rewritten to eliminate the pronoun). Reflexive pronoun. Vague pronoun reference where the reader has to keep in mind context to figure out what the pronoun s antecedent is (also counts as a minor Clarity error). G. Punctuation Errors Commas (commas in lists addressed by list errors) Comma needed before a quote (if appropriate). Comma needed between coordinate adjectives. Comma needed for clarity. For example, Ever since, Frank has been a better person versus Ever since Frank has been a better person (sentence fragment). If I have to read a sentence twice to understand it (like the last one in the example) that will add a minor Clarity error to this punctuation error for a total of two minor error points being deducted. Comma needed to set off a non-restrictive element. Comma not correctly used with while. Comma not needed for a compound predicate. Comma separating the subject from its verb. Comma used for convention (address, date, direct address, or place name; misuse with numbers other than dates and addresses is considered a major error). Commas needed between items in a series of three or more instead of using and or or repeatedly. H. Punctuation Errors Other Brackets or parentheses. Capitalization. Colon. Dash or hyphen. Ellipsis. Italicization or underlining (including in a reference item). Period missing from the last sentence in a paragraph (missing within a paragraph
8 Merchant page 8 counts as a run-on a major error). Punctuation in equation or formula. Semicolon. Slash misuse or overuse. Spacing after a period. Unnecessary punctuation (for example, commas in inline lists of only two items, punctuation after single words or clauses in a list that is not part of a sentence). I. Quotation/Quote Mark Errors Misplaced punctuation: comma or period not tucked inside quote. For example, a period before the opening parenthesis of an inline citation located at the end of a sentence instead of after the closing parenthesis. Quotation marks. (Single quote and double quotes mixed incorrectly either for a quote or when nested or the opening or closing quotation mark is missing from a quote, but both not are missing. If both marks in a set are missing, that is a major error and can fail a paper on its own.) J. Symbol Errors Copyright or trademark symbol. Percent symbol. Correctness: Spelling Errors Writing needs to consistently follow the Style Guide for using abbreviations, acronyms, contractions, and initialisms. Be aware that each instance of a spelling error is counted: a word that is used several times and is misspelled only once or twice in a paper is less of an error than a word that is used several times and is misspelled every time. Partly this is because of professional appearance: writing with multiple errors has a lower ethos. Misspellings and wrong word choices also increase chances of misreading, especially by those whose first language is not English; misspellings and wrong word choices also increase the price of properly translating a document. COR-S 1. Major Errors A. Misspelled words or abbreviations (including acronyms and initialisms). B. Misused possessive pronouns. C. Nonexistent words (words that are not accepted as official by major dictionaries; for example, alot and conversate are not proper words). D. Wrong word choices (including coordinating conjunctions, compound word errors [that changes the meaning of the sentence], prepositions, sexist language, sound-alikes, and transitions). An example of a major compound word error is back up (a verb) used instead of backup (a noun) or vice versa. COR-S 2. Minor Errors A. British spelling of a word. B. Compound word error that does not change the meaning of the sentence: two words should be a compound or a compound should be two words: space flight instead of the correct spaceflight or lifeform instead of the correct life form (yes, bands, songs, and Wikipedia use the incorrect lifeform. However, life form is the official spelling.
9 Merchant page 9 Potentially, another minor error is a word not using its first definition (first definition listed in a standard dictionary) but is otherwise properly used. However, for this course, I will ignore this error unless you are using the archaic definition of a word. Format/Professional Appearance Errors Writing must consistently follow required format including graphs, figures, headings, references, text, and tables. Technical writing is professional writing and needs to look that way. FOR 1. Major Errors A. Cover/Title Page Errors Elements are not placed on the page correctly. Pagination is visible. B. Heading Level Errors Heading levels are formatted incorrectly (color, font size, spacing, or typeface) and inconsistently applied (for example, a level-1 heading is sometimes in Tech Blue and sometimes black). This is in addition to the Accessibility error that this inconsistency creates; thus, you will lose points for Format and for Accessibility. Heading levels are the wrong types (level 1 formatted as a level 2, for example) and inconsistently applied. This is in addition to the Accessibility error that this inconsistency creates; thus, you will lose points for Format and for Accessibility. Heading levels are the wrong type but consistently applied (so that document hierarchy is still preserved, thus, no additional Accessibility penalty). Heading placements are wrong and inconsistently applied (this is in addition to the Accessibility error that this inconsistency creates; thus, you will lose points for Format and for Accessibility). C. Illustration/Visual Errors A table header row does not have the correct background color or text color. A table that has to split across two pages (resizing text does not help keep it from splitting across two pages) does not have the table header row repeated. A visual splits across at two pages when cropping, resizing (as long as clarity is not lost), or, for tables, changing the font size to 11 or 10 (no less than 10) could allow the visual to not split across two pages. It is better to have a few lines of white space at the bottom of a page than to have a visual split. D. Letterhead missing on memos E. List Errors (other than heading level errors) Lists indents are incorrectly and inconsistently formatted. Nested lists not formatted correctly (with errors being inconsistently applied). F. Page Header Errors Memo page headers are missing the date. Memo page headers are missing the To: line. Missing page numbers is a major accessibility error. Section break not used for a section. Each section where a section break is not used counts as a major error for a maximum of three times.
10 Merchant page 10 Page headers are not in the document header. White paper or technical report page headers are missing the report title. White paper or technical report page headers are missing the section title. G. Page Margins Not 1 Inch for Entire Document H. PDF file instead of Word file (as syllabus states, you must submit as a Word document). I. Spacing between lines change (inconsistent); for example, one paragraph can be singlespaced, and another paragraph the line spacing is J. Table of Contents/List of Illustration Errors Some or all lines missing ellipses. The spacing between most or all items in a glossary, list of illustrations, list of symbols, references, or table of contents wrong. Subheading listings not italicized (if some are and others are not, this inconsistency makes this a major error). K. Text Alignment Errors Text not aligned left, right, or centered as appropriate. For example, memo page heading is right-aligned instead of left-aligned. Vertical alignment of text error (off by more than two spaces). This includes a table of contents or a list of illustrations having sloppy alignments of text or page numbers. L. Text Font Errors Font choice is not one of the approved choices (Arial, Courier, Times New Roman). Font style (bold, italics, underlined, etc.) is incorrectly used for body text (includes captions, footnotes, and tables). Font size for body text is smaller than 10 or larger than 12 (includes captions, footnotes, and tables). If the size is much smaller or much larger, this can fail a paper. FOR 2. Minor Errors A. Glossary Errors Body text boldfaced instead of normal. Entries not formatted with hanging indents. Entry term not boldfaced. B. Heading Level Errors Heading levels are formatted incorrectly (color, font size, spacing, or typeface) but consistently applied (for example, all level-1 headings are in black and not in Tech Blue). Heading titles are not parallel in phrasing (see Style Guide). Headings back-to-back (with no intervening text). Headings bumped or orphaned (heading at bottom of a page) C. Illustration/Visual Errors Visual s placement is not centered or one per line. Visual s caption format is not correct. Visual s caption placement is not correct. D. Letterhead not in top margin (page header).
11 Merchant page 11 E. List Errors List indents incorrectly but consistently formatted. List only has one item. List bullet choice not as required by the Style Guide. List numbering choice for an inline, nested, or vertical list not as required by the Style Guide. List alignment or spacing between list items error. F. Other type style error: Body text not in black or web address is hyperlinked (blue text or underlined) Missing required font style (boldfaced or italicized), or wrong font style (all upper case, boldfaced, italicized, underlined). G. Page Header Errors The blank line between page header and body text is missing or incorrect size. The dash between section title and page number is incorrect or missing in white paper or technical report page headers. Pound sign (#) or other unapproved page numbering style). H. Page Margin Not 1 Inch on One Page (counts off for each page for a maximum of three pages, unless the document is three pages or less and every page has the wrong margin the entire document having the wrong page margin counts a major error even if the document is only two or three pages long). I. Reference Format Errors (MLA). J. Table of Contents/List of Illustration Errors The List of Illustrations has the list of tables before the list of figures. Subheading listings not italicized (if some are and others are not, this inconsistency makes this a major error). K. Text Alignment Errors A paragraph is indented. Each instance counts as an error up to three instances after which this becomes a major error. Spacing after a heading or paragraph not correct (too little or too much). Each instance counts as an error up to three times after which this becomes a major error. Spacing before heading, the first word in a paragraph, or between words off by 1 or 2 spaces (no space between words becomes a spelling error). The spacing between two items in a glossary, list of illustrations, list of symbols, references, or table of contents is wrong. Each instance counts as an error up to three instances after which this becomes a major error. The text is justified (aligned to both left and right margins). L. Titles (figure, page, paper, section, or table) not in proper title case (see Style Guide). Automatic Failing Grade Any of the following automatically fails your memo or paper. AUT-F. Automatic Fail Errors
12 Merchant page 12 A. Writing is not honest: as your textbook teaches, dishonest technical writing can open the writers and their organization to legal charges. Intentional plagiarism will earn a zero grade. Unintentional plagiarism (missing citations for material that is otherwise clearly quoted [in quote marks, for example]) or including visuals that are not your own but forgetting to cite them fails a paper. B. Writing is not accurate: as your textbook teaches, one wrong fact can confuse readers and can be dangerous. C. All page numbers are missing from a white paper s body. D. All illustrations in a short memo and most or all illustrations in a white paper are fuzzy or otherwise difficult to read can fail a paper. If a memo has one or two illustrations and one is difficult to read, it can lower the grade to a D. E. Paper is incomplete (missing a required section). F. Paper has so many clarity, formatting, grammar, or spelling errors it is burdensome to read or has a low-quality appearance (no longer professional). Automatic Zero Grade Any of the following automatically earns a zero grade for your memo or paper. AUT-0. Automatic Zero Grade Errors A. The assignment is not submitted or submitted after three days. B. Writing is not on an assigned topic. C. Writing is mostly plagiarized (earn a zero grade). A second occurrence fails the course and earns a referral to the Honor Council.
English 303 Rubric. Error Points. Marking Errors. Writing Corrections
Recall that an "A" paper is excellent. It is difficult to improve. It is submitted on time and demonstrates insight, originality, and attention to detail. It adheres to American English grammar and usage.
More informationEDITING & PROOFREADING CHECKLIST
EDITING & PROOFREADING CHECKLIST TABLE OF CONTENTS 1. Conduct a First Pass... 2 1.1. Ensure effective organization... 2 1.2. Check the flow and tone... 3 1.3. Check for correct mechanics... 4 1.4. Ensure
More informationOUTLINE. Advanced Technical Communication & Writing Skills. What is technical communication? Technical communication skills
Advanced Technical Communication & Writing Skills What is technical communication? Technical communication skills Principles of technical writing Technical writing is interpreting Planning is crucial Technical
More informationAlphabetical Index referenced by section numbers for PUNCTUATION FOR FICTION WRITERS by Rick Taubold, PhD and Scott Gamboe
Alphabetical Index referenced by section numbers for PUNCTUATION FOR FICTION WRITERS by Rick Taubold, PhD and Scott Gamboe?! 4.7 Abbreviations 4.1.2, 4.1.3 Abbreviations, plurals of 7.8.1 Accented letters
More informationFORMAT & TYPING GUIDE
FORMAT & TYPING GUIDE for CEATI Reports updated March 2018 Timeline of a Report Pre-Writing As you sit down to write the report, ensure you begin by downloading the most recent CEATI template at www.ceati.com/rfps.
More informationPaper Proof Manual. As a Student... Paper Proof Manual
Paper Proof consists of a large whiteboard region. Along the left hand side is the buttons bar. Details on the various button bar items will be given here. Along the top of the paper proof page is a tool
More informationCSc Senior Project Writing Software Documentation Some Guidelines
CSc 190 - Senior Project Writing Software Documentation Some Guidelines http://gaia.ecs.csus.edu/~buckley/csc190/writingguide.pdf Technical Documentation Known Problems Surveys say: Lack of audience definition
More informationStudent Guide for Usage of Criterion
Student Guide for Usage of Criterion Criterion is an Online Writing Evaluation service offered by ETS. It is a computer-based scoring program designed to help you think about your writing process and communicate
More informationView and Submit an Assignment in Criterion
View and Submit an Assignment in Criterion Criterion is an Online Writing Evaluation service offered by ETS. It is a computer-based scoring program designed to help you think about your writing process
More informationTechnical Paper Style Guide
AACE International Technical Paper Style Guide Prepared by the AACE International Technical Board Revised February 3, 2017 Contents 1. Purpose... 3 2. General Requirements... 3 2.1. Authorship... 3 2.2.
More informationFormal Figure Formatting Checklist
Formal Figure Formatting Checklist Presentation of Data Independent values are plotted on the x-axis, dependent values on the y-axis In general, no more than five curves to a figure (may be more or less
More informationCSc Senior Project Writing Software Documentation Some Guidelines
CSc 190 - Senior Project Writing Software Documentation Some Guidelines http://gaia.ecs.csus.edu/~buckley/csc190/writingguide.pdf 1 Technical Documentation Known Problems Surveys say: Lack of audience
More informationTechnical Writing. Professional Communications
Technical Writing Professional Communications Overview Plan the document Write a draft Have someone review the draft Improve the document based on the review Plan, conduct, and evaluate a usability test
More informationStat 582 Writing Rubric (First six items from Kansas State Dept of Education rubric)
Stat 582 Writing Rubric (First six items from Kansas State Dept of Education rubric) 1. Ideas/Content (Development) The writing is clearly focused which leads to achieving a well-defined goal. The purpose
More informationBrief Contents. PART 1 The Basics 1. PART 2 AP Style 35. PART 3 Punctuation and Usage 133
Brief Contents Preface xvii PART 1 The Basics 1 1. The Role of the Copy Editor 3 2. Editing Content 11 3. Copy Editing for Print and Online 19 4. Legal, Ethical and Inclusive-Language Concerns for Copy
More informationContents. Contents iii
Contents iii Contents Topical Guide vi Preface xi Part 1: Web Writing and Design Principles 1 Comparing Online and Print Documents 2 Understanding the Writing Process 2 Writing For Your Audience 3 Providing
More informationGuidelines for Authors (full paper submissions)
Guidelines for Authors (full paper submissions) file format Please save your document Microsoft Word 97-2003 document (.doc) or (.docx). word-count Your submission must not exceed 3,000 words exclusive
More informationMega International Commercial bank (Canada)
Mega International Commercial bank (Canada) Policy and Procedures for Clear Language and Presentation Est. Sep. 12, 2013 I. Purposes: The Mega ICB (C) distributes a limited range of retail banking services,
More informationThe next several pages summarize some of the best techniques to achieve these three goals.
Writing and Reviewing Documents You are required to write the following documents in this course: 1) A description of your GPS data collection and results. 2) A technical description of a data collection
More informationBAMSI Style and Editorial Guide. May 2011 Community Relations 10 Christy s Drive Brockton, MA 02301
BAMSI Style and Editorial Guide May 2011 Community Relations 10 Christy s Drive Brockton, MA 02301 It is important that, as an agency, BAMSI is represented in a professional manner that demonstrates our
More informationWRITING FOR THE WEB. UIUC Web Governance
WRITING FOR THE WEB UIUC Web Governance HOW USERS READ ON THE WEB UIUC Web Governance Scan text instead of reading word by word Often hurried, looking for something specific or wanting to complete a task
More information19. Bulleted and Numbered Lists
Kennesaw State University DigitalCommons@Kennesaw State University Sexy Technical Communications Open Educational Resources 3-1-2016 19. Bulleted and Numbered Lists David McMurray Follow this and additional
More informationMASTER OF EDUCATION STYLE GUIDE: A CLARIFICATION OF THE SIXTH ED. APA PUBLICATION MANUAL
MASTER OF EDUCATION STYLE GUIDE: A CLARIFICATION OF THE SIXTH ED. APA PUBLICATION MANUAL November, 2011 STYLE GUIDE 2 Master of Education follows the APA Publication Manual, 6 th Edition. This style guide
More informationText Processing (Business Professional)
Unit Title: Mailmerge OCR unit number: 06994 Level: 2 Credit value: 5 Guided learning hours: 50 Unit reference number: F/505/7091 Unit aim Text Processing (Business Professional) This unit aims to equip
More informationSECTION 2: PUNCTUATION
PUNCTUATION SECTION 2: PUNCTUATION This section will cover the use of: Commas Quotation Marks Hyphens 2 When to Use Commas% A comma is like a small pause in your sentence. Commas are often misused. Taking
More informationHotmail Documentation Style Guide
Hotmail Documentation Style Guide Version 2.2 This Style Guide exists to ensure that there is a consistent voice among all Hotmail documents. It is an evolving document additions or changes may be made
More informationBMIT Capstone Course Business Plan Rubric. Name of Social Enterprise: Type of Business: Owners Name: Evaluator(s):
BMIT Capstone Course Business Plan Rubric Name of Social Enterprise: Type of Business: Owners Name: Evaluator(s): Business Plan Rubric 0 = no evidence 1 = little evidence or major flaws 2 = adequate minimum
More informationInterdisciplinary Journal of Best Practices in Global Development Final Manuscript Preparation Guidelines
Interdisciplinary Journal of Best Practices in Global Development Final Manuscript Preparation Guidelines This document provides details on typesetting and layout requirements pertaining to final manuscript
More informationanalysis by Kendra Charles WORD COUNT 723 CHARACTER COUNT 3463 PAPER ID
analysis by Kendra Charles WORD COUNT 723 CHARACTER COUNT 3463 TIME SUBMITTED 12-APR-2012 11:53PM PAPER ID 241863456 " " 1 2 3 " " Delete ww Contractions ww concis ww concis Contractions coh 4 concis w
More informationewic: Information for Authors
ewic: Information for Authors 1st Author s name 2nd Author s name 3rd Author s name Author s affiliation Author s affiliation Author s affiliation Authors address Authors address Authors address Author
More informationReport Template. Joe B. Student and Dan Simon * Department of Electrical and Computer Engineering Cleveland State University Cleveland, Ohio 44115
Joe B. Student and Dan Simon * Department of Electrical and Computer Engineering Cleveland State University Cleveland, Ohio 44115 May 20, 2004 Abstract Every report should have an abstract. The abstract
More informationFor Teachers Engineering Design in Oregon Science Classrooms Page 1 of 6. EDOSC Style Guide. Subtitle
For Teachers Engineering Design in Oregon Science Classrooms Page 1 of 6 EDOSC Style Guide Subtitle 1 TITLE, SUBTITLE, AND HEADING ONE 1.1 Title The title is 20-point Times New Roman, underlined, and centered.
More informationLiterary Analysis. by Aminah Marshall WORD COUNT 1428 CHARACTER COUNT 6554 PAPER ID
Literary Analysis by Aminah Marshall WORD COUNT 1428 CHARACTER COUNT 6554 TIME SUBMITTED 12-APR-2012 11:26PM PAPER ID 241869086 Title First Person red " " 1, 2 coh " " 3, concis First Person 4 ~ frag Colloquialism
More informationTABLE OF CONTENTS PART I: BASIC MICROSOFT WORD TOOLS... 1 PAGE BREAKS... 1 SECTION BREAKS... 3 STYLES... 6 TABLE OF CONTENTS... 8
TABLE OF CONTENTS PART I: BASIC MICROSOFT WORD TOOLS... 1 PAGE BREAKS... 1 SECTION BREAKS... 3 STYLES... 6 TABLE OF CONTENTS... 8 LIST OF TABLES / LIST OF FIGURES... 11 PART II: FORMATTING REQUIREMENTS:
More informationEstablishing the FRG Newsletter
Handout #11 Establishing the FRG Newsletter Reasons for Using a Newsletter # Reach a small audience # Communicate to a specific group with common interests # Save meeting time # Provide recognition # Introduce
More informationElectronic Production Guidelines
Electronic Production Guidelines Illustrations It is a good idea to check out the draw programs you have available to you before you start drawing the figures for your article. Make sure that you can create
More informationLONGWARE, Inc. Style Guide
[well, this is the most thorough style guide on that document I have ever seen. I sense that you have been around some style guides in your life. how about a revision for perfection?] LONGWARE, Inc. Style
More informationTypesetting Tips. Put your best type forward.
Typesetting Tips Put your best type forward. Do you want your audience to read your document? Improve your chances by making your article easy to read. Make the document difficult to read and To learn
More informationAssessment of Informational Materials (AIM) Tool. Funded by Alberta Enterprise and Education
Assessment of Informational Materials (AIM) Tool Funded by Alberta Enterprise and Education AIM Tool Factor to be Rated 1. Content a. Purpose b. Scope c. Summary and Review 2. Word and Sentence Complexity
More informationECC Style Guide. ECC Style Guide
ECC Style Guide ECC Style Guide 23 November 2011 Page 2 0 EXECUTIVE SUMMARY This document provides guidance to introduce consistency across all Electronic Communications Committee (ECC) communications
More informationStyle template and guidelines for SPIE Proceedings
Style template and guidelines for SPIE Proceedings Anna A. Author1 a and Barry B. Author2 b a Affiliation1, Address, City, Country; b Affiliation2, Address, City, Country ABSTRACT This document shows the
More informationText Processing (Business Professional)
Unit Title: Mailmerge OCR unit number: 06971 Level: 1 Credit value: 4 Guided learning hours: 40 Unit reference number: R/505/7080 Unit aim Text Processing (Business Professional) This unit aims to equip
More informationTEXT PROCESSING (BUSINESS PROFESSIONAL) Mailmerge Level 1 (06971) Credits: 4. Learning Outcomes The learner will 1 Be able to use a word processor
TEXT PROCESSING (BUSINESS PROFESSIONAL) Mailmerge Level: 1 06971 Credits: 4 Learning Time: 40 hours Learning Outcomes The learner will 1 Be able to use a word processor 2 Be able to key in text from handwritten
More informationDetailed Format Instructions for Authors of the SPB Encyclopedia
Detailed Format Instructions for Authors of the SPB Encyclopedia General Formatting: When preparing the manuscript, the author should limit the use of control characters or special formatting. Use italics
More informationSTYLE GUIDE FOR COMPANY DOCUMENTATION
STYLE GUIDE FOR COMPANY DOCUMENTATION TABLE OF CONTENTS INTRODUCTION ALPHABETICAL LISTING TEMPLATES Letter template Fax template Memo template Report template Invoice template Quote template Order template
More informationCommunicating Through Top 10 Dos and Donʼts! Presented by Geri Ann Fuller!
Communicating Through E-mail: Top 10 Dos and Donʼts! Presented by Geri Ann Fuller! 1. Donʼt put anything in an e-mail that you are not willing to see on the front page of the newspaper." Most companies
More informationUsage And Punctuation Standards
Usage And Punctuation Standards Usage Standards The following discussion of fragments, comma splices, run-on sentences, and agreement problems will demonstrate common usage errors and how to correct them.
More informationPERFECT-EDIT.COM PROFESSIONAL EDITING & WRITING SERVICE. About Perfect Edit
About Perfect Edit PERFECT-EDIT. COM offers professional Editing and Writing Services for the discerning author and publisher. Our expertise covers the literary genre: Fiction-novels, Story books; Nonfiction:
More informationUniversal Design Principles Checklist
Universal Design Principles Checklist February 2012 The concept of Universal Design was developed by people who worked on designing equipment and environments for people with a disability. They saw that
More informationINCOSE IS2018 Paper Manuscript Instructions
IMPORTANT! As was the case for IS 2017 a Double-Blind Peer Review process will again be used. This means that the identity of the reviewer will be concealed from the author and the author s identity will
More informationText Processing (Business Professional) within the Business Skills suite
Text Processing (Business Professional) within the Business Skills suite Unit Title: Mailmerge OCR unit number: 06971 Unit reference number: T/501/4173 Level: 1 Credit value: 4 Guided learning hours: 40
More informationJOINT TEST AND EVALUATION PROGRAM STYLE GUIDE. June 29, 2007
JOINT TEST AND EVALUATION PROGRAM STYLE GUIDE Supplement to the Joint Test and Evaluation Program Handbook June 29, 2007 Approved By: This page intentionally left blank. TABLE OF CONTENTS CHAPTER 1 INTRODUCTION...
More informationWORD XP/2002 USER GUIDE. Task- Formatting a Document in Word 2002
University of Arizona Information Commons Training Page 1 of 21 WORD XP/2002 USER GUIDE Task- Formatting a Document in Word 2002 OBJECTIVES: At the end of this course students will have a basic understanding
More informationCharles Ball Fifty Years in Chains
Charles Ball Fifty Years in Chains by Jamal Cosby WORD COUNT 1875 CHARACTER COUNT 8618 TIME SUBMITTED 27-MAR-2012 09:25PM PAPER ID 238362388 Topic? 1 cs 2 frag 3 4 awk lc 5 Development ~ MLA 7 6 fs MLA
More informationText Processing (Business Professional) within the Business Skills suite
Text Processing (Business Professional) within the Business Skills suite Unit Title: Document presentation OCR unit number: 03934 Unit reference number: K/501/4218 Level: 3 Credit value: 6 Guided learning
More informationText Processing (Business Professional) within the Business Skills suite
Text Processing (Business Professional) within the Business Skills suite Unit Title: Word processing OCR unit number: 03938 Unit reference number: M/501/4219 Level: 3 Credit value: 6 Guided learning hours:
More informationName: Class: Date: 1. The search term entered in the Navigation pane appears in bold wherever it appears in the document.
NEW PERSPECTIVES MICROSOFT OFFICE 365 AND WORD 2016 INTRODUCTORY 1ST EDITION SHAFFER TEST BANK Full download at: https://testbankreal.com/download/new-perspectives-microsoft-office-365-word-2016- introductory-1st-edition-shaffer-test-bank/
More informationJournal Text Styles:
Journal Text Styles: International Journal of Work-Integrated Learning Karsten Zegwaard 16 February, 2018 Each journal develops their own style. A journal style is important for the journal s professional
More informationUniversity of Wisconsin - Stout
University of Wisconsin - Stout http://www.uwstout.edu/soe/profdev/pptrubric.html This rubric may be used for self-assessment and peer feedback. project grade will be based upon the following evaluation
More informationBFPA CONFERENCE- POWERPOINT PRESENTATION FORMAT
BFPA CONFERENCE- POWERPOINT PRESENTATION FORMAT These guidelines are designed to help you prepare a successful conference presentation. PREPARING YOUR POWERPOINT PRESENTATION Please note the following:
More informationText Processing (Business Professional)
Text Processing (Business Professional) Unit Title: Document Presentation OCR unit number: 06978 Level: 2 Credit value: 5 Guided learning hours: 50 Unit reference number: J/505/7092 Unit aim This unit
More informationPOFT 2301 INTERMEDIATE KEYBOARDING LECTURE NOTES
INTERMEDIATE KEYBOARDING LECTURE NOTES Be sure that you are reading the textbook information and the notes on the screen as you complete each part of the lessons in this Gregg Keyboarding Program (GDP).
More informationText Processing (Business Professional)
Text Processing (Business Professional) Unit Title: Document Presentation OCR unit number: 03934 Level: 3 Credit value: 6 Guided learning hours: 60 Unit reference number: K/501/4218 Unit aim This unit
More informationLesson 2 Writing Business Reports. Henan University of Technology Sino-British College Transfer Abroad Undergraduate Programme
Lesson 2 Writing Business Reports Henan University of Technology Sino-British College Transfer Abroad Undergraduate Programme Learning Objectives 1. Explain report functions and types 2. Apply the 3-x-3
More informationSAMPLE PAPER FOR AN IGBR JOURNAL OR PROCEEDINGS PUBLICATION
SAMPLE PAPER FOR AN IGBR JOURNAL OR PROCEEDINGS PUBLICATION John Smith, University of Abcdef ABSTRACT Each paper must start off with an abstract (with the exception of case studies). The abstract should
More informationUpdated: October 2017 (Please see for the most current information.)
Updated: October 2017 (Please see https://www.atanet.org/certification for the most current information.) 1 is a testament to a translator's professional competence in translating from one specific language
More informationStylesheet Studies in the Linguistic Sciences: Illinois Working Papers
Stylesheet Studies in the Linguistic Sciences: Illinois Working Papers Ratified by the SLS Editorial Board 11/21/08. Guidelines subject to change before publication. 1. General comments: Please submit
More informationcontextual. Also include information about the artist, if known.
AP HISTORY OF ART/Dr. Schiller PowerPoint Project; Winter Break 2015-2016: 200 DUE FIRST CLASS AFTER WINTER BREAK 1. You must create a PowerPoint presentation meeting all the criteria below: i. Make a
More informationNational Electrical Safety Code Manual of Style
National Electrical Safety Code Manual of Style Introduction The National Electrical Safety Code (NESC) is also known as American National Standard C2. It is a consensus standard that has been prepared
More informationDissertation Formatting Rules. Basic Format
All doctoral students will follow APA (6 th edition) formatting for the narrative portion of the dissertation. Refer to this guide for rules specific to Missouri Baptist University dissertations. *Instructions
More informationMLA Format. Example and Formatting Instructions. Prepared by the Clarendon College English Department and Computer Science Department
MLA Format Example and Formatting Instructions Prepared by the Clarendon College English Department and Computer Science Department Example MLA Format Fleming 1 John Fleming Professor Daniels ENGL 1301
More informationClear language and design. Joan Acosta
Clear language and design Joan Acosta What is clear writing? Clear writing involves thinking about your readers and writing for them. It does not mean simply replacing difficult words with easier words
More informationFor proceedings contributors: general submission procedures and formatting guidelines for L A TEX2E users
1 For proceedings contributors: general submission procedures and formatting guidelines for L A TEX2E users 1. Points to Remember (a) Please ensure quotation marks are paired correctly. (b) Italicized
More informationMasthead Byline Font Orientation. White space Contrast Placement Body. Alignment Caption Drop capital Alley
Appendix A Sample Word Wall Terms Masthead Byline Font Orientation White space Contrast Placement Body Alignment Caption Drop capital Alley 1. Appendix B Word Wall Definitions Masthead Byline Alley Font
More informationChapter 6 Revising Business Messages
Chapter 6 Revising Business Messages Topics in This Chapter Revising Tips Designing Documents for Readability How to Proofread Documents Proofreading Marks for Digital and Hard-Copy Documents How to Evaluate
More informationISAE2013 Conference Proceedings Format Sample File
ISAE2013 Conference Proceedings Format Sample File First AUTHOR 1, Second M. AUTHOT 2, Third AUTHOT 3 1,2 Affiliation Address 1,2 e-mail address 3 Affiliation Address 3 e-mail address ABSTRACT: In this
More informationEditorial Style. An Overview of Hofstra Law s Editorial Style and Best Practices for Writing for the Web. Office of Communications July 30, 2013
Editorial Style An Overview of Hofstra Law s Editorial Style and Best Practices for Writing for the Web Office of Communications July 30, 2013 What Is Editorial Style? Editorial style refers to: Spelling
More informationBDA Dyslexia Style Guide
BDA Dyslexia Style Guide This Guide is in three parts: 1. Dyslexia Friendly Text 2. Accessible Formats 3. Website design 1. Dyslexia Friendly Text. The aim is to ensure that written material takes into
More informationGuidelines & Instructions for Manuscript Preparation
Distributor of Scholarly Books Guidelines & Instructions for Manuscript Preparation or How to Get your Book Published and Make your Production Team Happy 1 2 important Please make sure that your manuscript
More informationText Processing (Business Professional)
Unit Title: Speed Keying OCR unit number: 06998 Level: 2 Credit value: 4 Guided learning hours: 40 Unit reference number: Y/505/7095 Unit aim Text Processing (Business Professional) This unit aims to equip
More informationGetting Started With Syntax October 15, 2015
Getting Started With Syntax October 15, 2015 Introduction The Accordance Syntax feature allows both viewing and searching of certain original language texts that have both morphological tagging along with
More informationWBJS Grammar Glossary Punctuation Section
WBJS Grammar Glossary Punctuation Section Punctuation refers to the marks used in writing that help readers understand what they are reading. Sometimes words alone are not enough to convey a writer s message
More informationIntroduction to MS Word XP 2002: An Overview
Introduction to MS Word XP 2002: An Overview Sources Used: http://www.fgcu.edu/support/office2000/word/files.html Florida Gulf Coast University Technology Skills Orientation Word 2000 Tutorial The Computer
More informationWR227 Summary Notes Days 13 and 14
WR227 Summary Notes Proofreading The most effective way to proofread is to carefully do it yourself aloud and to then have someone else read the document to you aloud. Since you know the material, you
More informatione-issn: INTERNATIONAL JOURNAL OF INFORMATIVE & FUTURISTIC RESEARCH Paper Writing Instructions
Authors Are Instructed To Follow IJIFR Paper Template And Guidelines Before Submitting Their Research Paper (Font: Times New, Size 24, Centred, Capitalize each Word) Dr. Moinuddin Sarker 1 and Dr. Fu-Chien
More informationGuidelines for Ethical Editing of Theses / Dissertations 1
Guidelines for Ethical Editing of Theses / Dissertations 1 Introduction Academia uses theses as one way of testing the ability of students, especially graduate students, to use written words for communicating
More informationCREATING A STYLE GUIDE FOR YOUR ORGANISATION
CIPR SKILLS GUIDE CREATING A STYLE GUIDE FOR YOUR ORGANISATION #CIPR @CIPR_UK WHY HAVE A STYLE GUIDE? Sloppy writing, jargon, long sentences and incomprehensible waffle ironically communicates one thing
More informationDEPARTMENT OF ELECTRONIC ENGINEERING GUIDE TO TECHNICAL REPORT WRITING
DEPARTMENT OF ELECTRONIC ENGINEERING GUIDE TO TECHNICAL REPORT WRITING Introduction A technician who is unable to communicate effectively with his superiors or colleagues will never receive due credit
More informationFAO Online Style Guide Version 1.0
FAO Online Style Guide Version 1.0 Last updated: May 2012 1 Introduction Consistency is an important way to make on-screen text clear and easy to read. This Guide defines consistent Web writing recommendations,
More informationNotes on Writing Mathematics
Notes on Writing Mathematics A. Parts of the paper Mathematics papers generally follow a standard pattern. Abstract. Many journals demand an abstract, and many mathematicians are in the habit of providing
More informationAcademic assignment presentation and submission
Academic assignment presentation and submission Assignment presentation and submission The following are CHC standard format requirements for student assignments. Please see your school s CHC Reference
More informationGuidelines on the correct use of the UBA document templates for research reports and surveys
Guidelines on the correct use of the UBA document templates for research reports and surveys Publisher Umweltbundesamt (German Environment Agency) Wörlitzer Platz 1 06844 Dessau-Roßlau, Germany Contact
More informationPaper Template in One-Column Format
Submitted for publication in proceedings of National Conference on Recent Trends in Technology and Management 2016 (NCRTTM 2016) Paper Template in One-Column Format Author's Name a and Author's Name b
More informationText Processing (Business Professional)
Unit Title: Audio-Transcription OCR unit number: 03933 Level: 3 Credit value: 5 Guided learning hours: 50 Unit reference number: J/505/7108 Unit aim Text Processing (Business Professional) This unit aims
More informationSAMPLE PAGES. Syllabus coverage chart. viii Syllabus coverage chart
viii Syllabus coverage chart Syllabus coverage chart The chart below shows how each Unit and Topic relates to the ICT syllabus and the Computer Studies syllabus. Computer Unit 11.1 Computer Fundamentals
More informationTypography/ Layout and Design
Typography/ Layout and Design What is typography? It s the study and science of fonts. Using typography is almost an art, and it takes practice to learn to use it correctly. Type is not just text that
More informationProject 10H Boards Summary
Content-Based Assessments GO! Fix It Project Files Project 10H Boards Summary For Project 10H, you will need the following files: w10h_boards_summary w10h_contact_information Lastname_Firstname_10H_Boards_Summary
More information6. RESEARCH POSTERS II
Geomorphology 6. Research Posters II 6. RESEARCH POSTERS II 100 Points As explained in lab exercise two, communication of scientific experimental results is a critical part of the scientific method. As
More informationGuidelines for Writing Mathematical Proofs
Appendix A Guidelines for Writing Mathematical Proofs One of the most important forms of mathematical writing is writing mathematical proofs. The writing of mathematical proofs is an acquired skill and
More informationSOUTHWEST DECISION SCIENCES INSTITUTE INSTRUCTIONS FOR PREPARING PROCEEDINGS
SOUTHWEST DECISION SCIENCES INSTITUTE INSTRUCTIONS FOR PREPARING PROCEEDINGS IMPORTANT NOTES: All camera-ready submissions must be submitted electronically via the conference management system (Easy Chair)
More information