CSc Senior Project Writing Software Documentation Some Guidelines

Size: px
Start display at page:

Download "CSc Senior Project Writing Software Documentation Some Guidelines"

Transcription

1 CSc Senior Project Writing Software Documentation Some Guidelines

2 Technical Documentation Known Problems Surveys say: Lack of audience definition Poor structure Disdain for the reader Unclear writing Poor use of illustrations

3 Technical Writing Be clear about what exactly is the purpose of the document you are writing. This means, who is going to read it and why. Use the Map Analogy Think of reader undertaking a journey the reading of your document. You are supplying a well annotated map for that reader. Remember the Technical Writer s Golden Rule: Always put yourself in the reader s place.

4 Basic Solutions Understand your audience Address the reader directly Keep the information manageable Use illustrations wherever possible Don t just write, rewrite (it s a process!!) Give readers access to what they want Make sure the facts are accurate Allow for readability factors

5 Senior Project Style Manual All documents will have an Introduction as the first section. This serves as the executive summary for the document as such, it should be written last. 1 Introduction. 1.1 Purpose. 1.2 Scope. 1.3 Definitions, acronyms, abbreviations. 1.4 References. 1.5 Overview. Glossary

6 Numbering Sections and Subsections Headings should clearly describe the contents of the section or subsection. Section Headings in UPPER CASE. Subsection Heading words capitalized. Section Headings and Subsection Titles in BOLD and ending with a period. Section text begins as a new paragraph Subsection text follows heading on same line. Referencing: (see Section 1) or (see ).

7 Page Numbers and Spacing Header and Footer Information Include Page Number Options: Spacing Title of document Date Revision number Team name Body is single spaced Paragraphs separated by blank line

8 Lists Bulleted List Numbered List Numbered Sublist (1) (1) (2) (a) (3) (b) No punctuation One list per section/subsection (2)

9 Tables and Figures Number each Table or Figure followed by appropriate title. Table 1 Figure 1 Table 2 Figure 2 Table 3 Figure 3 Cite tables and figures in the text by specifying Table or Figure followed by the number. Examples: see Table 6 see Figure 10

10 APPENDICES APPENDIX A: < title > Section and subsections begin with the appendix letter (e.g. A.1, A.1.1.2, etc.) Must be referenced in the body of the document Useful by not essential information not essential does not mean unnecessary! Use appendices for information that does not fit in logically, or only needs to be referenced.

11 Glossary Definitions, Acronyms and Abbreviations Used in the document to save time and space, but only if their meaning is unquestionably clear to the reader. Abbreviations and Acronyms First appearance do not use the abbreviation or acronym: Spell it out!...with the abbreviation or acronym in parentheses. e.g. Maintenance Manual (MM) Subsequent references can then use the acronym or abbreviation

12 Citing References Format Book [1] Rumbaugh, J., M. Blaha, W. Premerlani, F. Eddy, and W. Lorensen. Object-Oriented Modeling and Design. Englewood Cliffs, NJ: Prentice Hall Article [2] Suchman, L. Representations of Work. Communications ACM 38, 9 (Sept. 1995): Reference [3] Institute of Electrical and Electronics Engineers, Inc. IEEE Standard for Developing Software Life Cycle Processes. ANSI/IEEE Std References are listed in subsection 1.4 of each document. In the body of the document, references should be cited where applicable, with reference number in brackets for example, [1] Modern Language Association (MLA)

13 Document from a Web Site Author. "Title of Web Page." Title of the Site. Editor. Date and/or Version Number. Name of Sponsoring Institution. Date of Access <URL> Sherman, Chris. "Everything You Ever Wanted to Know About URL." SearchEngineWatch. Ed. Danny Sullivan. 24 Aug Sept < hp/ >.

14 Myth of the Perfect Draft You can produce a nearly final version of your document in one attempt. Not true!!! At least 50% or your writing time is (should be) re-writing and editing.

15 Don t edit as you write Revising tips Go back a reread is the message clear! Some questions to answer: 1. Is the purpose immediately clear to the reader? 2. Is the message relevant to the reader? 3. Does each new thought make sense? 4. Do the thoughts flow smoothly and logically? 5. Are the thoughts clearly expressed?

16 More Strengthen your message! 1. Is the message complete 2. Are the words appropriate 3. Is the tone correct? Condense (shorten) your message.

17 Style Using the right tense Clarity Controlled English Sentence length Pompous style Technical terms and jargon Variety and inconsistency Numbers in text Using highlighting Capitalization Colloquialisms and slang Humor Using he or she Using must, should, can, and may Acronyms and abbreviations Punctuation Find a good technical writing reference text you will (should) use it

18 Using the right tense Present tense - typical Past tense sometimes when communication background information Future tense only when describing expected results A READ statement is used to assign the listed variables those values which are obtained from a DATA statement.

19 Active and Passive Voice VOICE: the way the subject (the doer) of the sentence is related to the action expressed by the verb. Active voice: to the point, sharp and clear. PASSIVE: The selection of this operation is made automatically by the software if there is no intervention by the operator. ACTIVE: Unless the operator intervenes, the software selects this function automatically. 19

20 Active and Passive Voice PASSIVE The program can be started by double clicking on the icon. ACTIVE Double-click on the icon to start the program. Note: Passive voice can be used if the doer in the sentence is unimportant! The sixteen bits of each word are numbered 0 to 15. The I/O units are both shown in Figure 2. The address of the File Control Block becomes the next free location on the stack. 20

21 Clarity Clear, concise, accurate! Never give an incomplete account of what the reader has to do. Too much detail is better than to little. KISS Keep it Simple and Straight Simple: avoid compound sentences 21

22 Why Controlled English? Controlled English: Standardizing word usage leads to improved customer acceptance/understanding. For non-english speakers, documents are easier to understand. Lower translation costs. When something is first named, use only that name in subsequent references to that something. Do not add adjectives 22

23 Sentence Length is Important Use short, simple sentences. Keep length between 13 and 21 words. Read and revise removing unnecessary words. Example You can use TM-BASIC to check that a value entered is within a certain range, to compare data against a value in another data variable, to perform check-digit calculations, or to perform other arithmetic and logical operations. You can use TM-BASIC to: Check that a value entered is within a certain range Compare data against a value in another data variable Perform check-digit calculations Perform other arithmetic and logical operations

24 Redundancy and Padding The result of: Unclear thinking Trying to impress The desire to produce a large volume of work Unwillingness to rewrite!!! Example: Due to the upcoming project submission to support the system upgrade as well as the introduction of the new products, the need is becoming eminent to identify all capital requirements of this process. Your input is important to the resolution of this issue. VERSUS Please supply your capital requirements for support of future 24 system upgrades and introduction of the new products.

25 Using Numbers Write all numbers between zero and twenty as one word. Write numbers thirty, forty, fifty, sixty, seventy, eighty, and ninety as one word. Use hyphens to separate tens and units of numbers like twenty-one. Write numbers above ninety-nine as Arabic numbers (for example, 110). Never split a number across two lines. 25

26 Highlighting text: Miscellaneous use bold, italics, or underline never use quotation marks Colloquialisms (informal, regional), slang and humor don t!!! What about use of (must and should) as opposed to (can and may)? Must means the action is required. Should means that it is advisable. Can implies capability. May is vague, being interpreted as meaning permissive or possible.

27 Highlighting text: More Miscellaneous Never use underlining for emphasis (difficult to read) Bold for main section headings, subsection headings, figure and table titles, emphasis, commands, file and dirctory names Italics for references to other manuals, symbolic names, variables in command syntax, long pieces of user input Capitalization Chapter & appendix titles Section headings Figure and table names Acronyms Entries in a glossary

28 One More Miscellaneous Leading capital letter Subsection headings References to sections in text All heading entries in Table of Contents Main entries in an index Nmes of screen fields and menu items 28

29 He or She? Address your reader directly to avoid use of he or she. Those places where you think you need to make a choice, rewrite! Examples: If this happens, tell your administrator. he will have to reset your password before you can log-in again. If this happens, ask the system administrator to reset the password and log-in again. Change the workstation database to include the new workstation, and ask him to log-in again. Change the workstation database to include the new workstation, and ask the user to log-in again. 29

30 Ellipses Punctuation indicates something is missing from a quotation indicates section of text has been omitted Colon precedes a list used when connected to the ideas namely, as follows, because, (even if these phrases are not used but can be implied). Semicolon used to separate two clauses which are closely connected. Example: Secretarial is the adjective corresponding to secretary; secretariat is the official establishment of a secretary.

31 Parentheses More Punctuation Advice Used to add a short remark without interrupting the flow of the sentence. The network addresses (which are specified during installation cannot be changed). Note. Sometimes hyphens - sort of like this - are used instead. Quotation marks Use for genuine quotations Use double quotation marks to enclose a quote Use single quotation marks for quotations within a quotation (She said Did you know he said )

CSc Senior Project Writing Software Documentation Some Guidelines

CSc 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 information

EDITING & PROOFREADING CHECKLIST

EDITING & 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 information

OUTLINE. Advanced Technical Communication & Writing Skills. What is technical communication? Technical communication skills

OUTLINE. 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 information

Technical Paper Style Guide

Technical 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 information

Technical Writing. Professional Communications

Technical 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 information

19. Bulleted and Numbered Lists

19. 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 information

WPPD Senior Pharmaceutical Care (PC) Paper Evaluation Student Name:

WPPD Senior Pharmaceutical Care (PC) Paper Evaluation Student Name: WPPD Senior Pharmaceutical Care (PC) Paper Evaluation Student Name: First Draft Evaluation by: Date Reviewed: THE SUBMITTED DRAFT FOR REVIEW BY UF EDITORIAL TEAM: is ACCEPTABLE pending final report with

More information

FAO Online Style Guide Version 1.0

FAO 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 information

Hotmail Documentation Style Guide

Hotmail 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 information

CREATING A STYLE GUIDE FOR YOUR ORGANISATION

CREATING 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 information

WBJS Grammar Glossary Punctuation Section

WBJS 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 information

Literary Analysis. by Aminah Marshall WORD COUNT 1428 CHARACTER COUNT 6554 PAPER ID

Literary 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 information

Contents. Contents iii

Contents. 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 information

MLA 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 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 information

FedRAMP General Document Acceptance Criteria. Version 1.0

FedRAMP General Document Acceptance Criteria. Version 1.0 Version 1.0 July 30, 2015 Revision History Date Version Page(s) Description Author 03/12/ 2015 0.6 All Draft Steve Levitas 05/05/2015 0.7 All Incorporated Monette Respress comments about acceptability

More information

Detailed Format Instructions for Authors of the SPB Encyclopedia

Detailed 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 information

LONGWARE, Inc. Style Guide

LONGWARE, 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 information

ECC Style Guide. ECC Style Guide

ECC 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 information

Charles Ball Fifty Years in Chains

Charles 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 information

Interdisciplinary Journal of Best Practices in Global Development Final Manuscript Preparation Guidelines

Interdisciplinary 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 information

Dissertation Formatting Rules. Basic Format

Dissertation 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 information

Alphabetical 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 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 information

Lesson 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 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 information

The next several pages summarize some of the best techniques to achieve these three goals.

The 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 information

Paper Proof Manual. As a Student... Paper Proof Manual

Paper 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 information

ISAE2013 Conference Proceedings Format Sample File

ISAE2013 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 information

Brief Contents. PART 1 The Basics 1. PART 2 AP Style 35. PART 3 Punctuation and Usage 133

Brief 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 information

FORMAT & TYPING GUIDE

FORMAT & 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 information

Analyzing PDFs with Citavi 6

Analyzing PDFs with Citavi 6 Analyzing PDFs with Citavi 6 Introduction Just Like on Paper... 2 Methods in Detail Highlight Only (Yellow)... 3 Highlighting with a Main Idea (Red)... 4 Adding Direct Quotations (Blue)... 5 Adding Indirect

More information

Report Template. Joe B. Student and Dan Simon * Department of Electrical and Computer Engineering Cleveland State University Cleveland, Ohio 44115

Report 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 information

Guidelines for Writing Mathematical Proofs

Guidelines 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 information

Instructions/template for preparing your NOLTA manuscript (Ver. 3.02, Aug. 28, 2015)

Instructions/template for preparing your NOLTA manuscript (Ver. 3.02, Aug. 28, 2015) NOLTA, IEICE Paper Instructions/template for preparing your NOLTA manuscript (Ver. 3.02, Aug. 28, 2015) Name Author1 1a), Name Author2 2, and Name Author3 1 1 Institute of Industrial Science, University

More information

SECTION 2: PUNCTUATION

SECTION 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 information

Mega International Commercial bank (Canada)

Mega 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 information

Defense Logistics Agency INSTRUCTION

Defense Logistics Agency INSTRUCTION Defense Logistics Agency INSTRUCTION Subject: Plain Language Program References: DLAI 5025.13 Effective September 10, 2015 Accountable Office: Headquarters Complex Strategic Plans and Policy, Policy Management

More information

WHY EFFECTIVE WEB WRITING MATTERS Web users read differently on the web. They rarely read entire pages, word for word.

WHY EFFECTIVE WEB WRITING MATTERS Web users read differently on the web. They rarely read entire pages, word for word. Web Writing 101 WHY EFFECTIVE WEB WRITING MATTERS Web users read differently on the web. They rarely read entire pages, word for word. Instead, users: Scan pages Pick out key words and phrases Read in

More information

Readers are wary of out of date content, so it's important to actively manage the information you publish.

Readers are wary of out of date content, so it's important to actively manage the information you publish. Web Style Guide Important tips for writing for the web People don t usually read for pleasure on the website. They are looking for a specific piece of information, and they don't want extraneous junk to

More information

TE Teacher s Edition PE Pupil Edition Page 1

TE Teacher s Edition PE Pupil Edition Page 1 Standard 4 WRITING: Writing Process Students discuss, list, and graphically organize writing ideas. They write clear, coherent, and focused essays. Students progress through the stages of the writing process

More information

analysis by Kendra Charles WORD COUNT 723 CHARACTER COUNT 3463 PAPER ID

analysis 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 information

English 303 Rubric. Error Points. Marking Errors. Writing Corrections

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 information

FOR EFFICIENT DICTATION

FOR EFFICIENT DICTATION TIPS FOR EFFICIENT DICTATION Page 1 / 6 1. Why dictate with Philips digital dictation systems? You can talk 7 times faster than you can write so you can record digitally far more speedily than on paper

More information

Typesetting Tips. Put your best type forward.

Typesetting 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 information

Writing Report Techniques

Writing Report Techniques 1. Paper Size and Format: The project report must be printed on A4 paper and students are required to follow these bullet points for printing style: 12-point font size text. 1.5 space line text. Page margins:

More information

Formal Figure Formatting Checklist

Formal 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 information

WRITING FOR THE WEB. UIUC Web Governance

WRITING 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 information

Student Guide for Usage of Criterion

Student 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 information

Writing Style Guide 2019

Writing Style Guide 2019 2019 Writing Style Guide Micro Focus Writing Style Guide 2 Contents About this Guide Best Practices Acronyms and Initialisms Active Voice Ampersands (&) Ellipses (... ) Email Em Dashes ( ) Product Names

More information

How to Write a Technical Manual that Users Can Actually Use

How to Write a Technical Manual that Users Can Actually Use How to Write a Technical Manual that Users Can Actually Use Robert Klimas Senior Engineer City of Toronto 2009 APWA International Public Works Congress & Exposition Wednesday, September 16, 2009 Columbus,

More information

o Changes that require author intervention, e.g., address/ requirements and/or missing sections, should be conveyed through remarks.

o Changes that require author intervention, e.g., address/ requirements and/or missing sections, should be conveyed through remarks. This document covers all Formatting-related points to be adhered to by all Enago Professional Editors when an author opts for Formatting. This is conveyed through the assignment email as Formatting: Yes,

More information

Editorial 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 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 information

Alfresco Voice Writing for the user interface

Alfresco Voice Writing for the user interface Alfresco Voice Writing for the user interface One day I will find the right words, and they will be simple. Jack Kerouac Contents Writing Tone - how to write Language - what to write Capitalization Abbreviations

More information

DEPARTMENT OF ELECTRONIC ENGINEERING GUIDE TO TECHNICAL REPORT WRITING

DEPARTMENT 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 information

The African Journal of Information Systems (AJIS) Publications Format Template

The African Journal of Information Systems (AJIS) Publications Format Template The African Journal of Information Systems (AJIS) Publications Format Template Research Paper Volume X, Issue X, Month YYYY, ISSN 1936-0282 NOTE: WHEN USING THIS TEMPLATE FOR THE REVIEW VERSION OF YOUR

More information

Longware, Inc INTERNAL STYLE GUIDE

Longware, Inc INTERNAL STYLE GUIDE 1 Longware, Inc INTERNAL STYLE GUIDE [could you go back and listen to my recording again? you miss some stuff here. Table of Contents About This Guide... 2 Highlighting... 3 Bold... 3 Italics... 3 Special

More information

Focus. Writing for the Web. Topics. Types of Web page. Print vs Web? Some Key Differences

Focus. Writing for the Web. Topics. Types of Web page. Print vs Web? Some Key Differences #pelc11 Focus Writing for the Web Words & Writing Page Layout Emphasis & Links Design Site Structure Matt Lingard, LSE Centre for Learning Technology Topics General Web Writing Guidelines Writing for Blogs

More information

Establishing the FRG Newsletter

Establishing 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 information

ewic: Information for Authors

ewic: 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 information

PERFECT-EDIT.COM PROFESSIONAL EDITING & WRITING SERVICE. About Perfect Edit

PERFECT-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 information

JOINT TEST AND EVALUATION PROGRAM STYLE GUIDE. June 29, 2007

JOINT 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 information

English 303 Rubric. Rubric Overview. Writing Corrections Instructions. Accessibility Errors

English 303 Rubric. Rubric Overview. Writing Corrections Instructions. Accessibility Errors 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

More information

Universal Design Principles Checklist

Universal 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 information

Ten Steps for Completing Your Submission

Ten Steps for Completing Your Submission Ten Steps for Completing Your Submission The ACC is currently accepting submissions for the Young Investigator Awards. All submitting authors must file up to date disclosures on the ACC's Disclosure Website

More information

Design Proposal: Outline

Design Proposal: Outline Design Proposal: Outline This outline should be used as a checklist to help each member of the team make sure that every section of the document meets the requirements for a design proposal. Writing Style

More information

View and Submit an Assignment in Criterion

View 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 information

The Baptist College of Florida. MLA Formatting Guide

The Baptist College of Florida. MLA Formatting Guide The Baptist College of Florida MLA Formatting Guide Spring 2018 Table of Contents Overview of an MLA Paper... 1 Creating a template for research papers... 2 Changing Word s default settings... 3 Change

More information

For 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 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 information

PROCEDIA CIRP Affiliated with CIRP, The International Academy for Production Engineering

PROCEDIA CIRP Affiliated with CIRP, The International Academy for Production Engineering .... PROCEDIA CIRP Affiliated with CIRP, The International Academy for Production Engineering AUTHOR INFORMATION PACK TABLE OF CONTENTS Description Editorial Board Guide for Authors XXX p.1 p.1 p.2 ISSN:

More information

MASTER 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 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 information

BDA Dyslexia Style Guide

BDA 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 information

BFPA CONFERENCE- POWERPOINT PRESENTATION FORMAT

BFPA 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 information

Microsoft Word Part 3 Office 2013

Microsoft Word Part 3 Office 2013 Microsoft Word Part 3 Office 2013 Hyperlinks When a document is sent as an electronic copy, hyperlinks can be added to direct the reader to a web page. To add a hyperlink: Highlight the word, phrase, paragraph,

More information

For proceedings contributors: general submission procedures and formatting guidelines for L A TEX2E users

For 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 information

English Business Writing Course KISS: Keep It Short and Simple. Date 10 March 2016

English Business Writing Course KISS: Keep It Short and Simple. Date 10 March 2016 English Business Writing Course KISS: Keep It Short and Simple Date 10 March 2016 Prepared for R&T Staff Presentation by Jennifer Lee Before we start Many of the points I will bring up in the lesson are

More information

Wiley-Blackwell Geographical Analysis (GA) Content Style Sheet THIS DOCUMENT LAST UPDATED ON: 16/JUN/2011. Journal house style points

Wiley-Blackwell Geographical Analysis (GA) Content Style Sheet THIS DOCUMENT LAST UPDATED ON: 16/JUN/2011. Journal house style points Wiley-Blackwell Geographical Analysis (GA) Content Style Sheet THIS DOCUMENT LAST UPDATED ON: 16/JUN/2011 Journal house style points Main style guides No guides to be followed Supplemented as necessary

More information

Chapter 5 Style Guide

Chapter 5 Style Guide Contributors Guide Chapter 5 Style Guide for LibreOffice.org User Guides Copyright This document is Copyright 2011 by its contributors as listed below. You may distribute it and/or modify it under the

More information

Firefighters Pensions (England) Scheme Advisory Board Paper 2. SAB communication and branding guidelines

Firefighters Pensions (England) Scheme Advisory Board Paper 2. SAB communication and branding guidelines Meeting of the Board 1 December 2017 ITEM 10 SAB communication and branding guidelines Purpose of report For decision. Background 1. A paper was presented to the Board for comment at the meeting of 30

More information

INTERNSHIP REPORT GUIDELINE (IRG) Please strictly follow the guidelines and be consistent throughout your document.

INTERNSHIP REPORT GUIDELINE (IRG) Please strictly follow the guidelines and be consistent throughout your document. INTERNSHIP REPORT GUIDELINE (IRG) Please strictly follow the guidelines and be consistent throughout your document. A. Content and logical organization related guidelines: 1. Weekly report (Haftalık Rapor)

More information

Office Wo Office W r o d r 2007 Revi i ng and R d Refifini ng a D Document

Office Wo Office W r o d r 2007 Revi i ng and R d Refifini ng a D Document Office Word 2007 Lab 2 Revising i and Refining i a Document In this lab, the student will learn more about editing documents They will learn to use many more of the formatting features included in Office

More information

Rube Goldberg Final Report Format

Rube Goldberg Final Report Format Rube Goldberg Final Report Format Group Assignment Your team is responsible for composing a single final report that describes in detail your Rube Goldberg machine. The audience of this report is the instructor

More information

Guidelines for Authors (full paper submissions)

Guidelines 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 information

Federal Plain Language Guidelines

Federal Plain Language Guidelines Federal Plain Language Guidelines March 2011 Revision 1, May 2011 Table of Contents Introduction... i Revision 1 Changes... ii Table of Contents... iii I. Think about your audience... 1 a. Identify and

More information

Microsoft Manual of Style, Fourth Edition Microsoft Corporation ISBN: First printing: January, 2012

Microsoft Manual of Style, Fourth Edition Microsoft Corporation ISBN: First printing: January, 2012 Microsoft Manual of Style, Fourth Edition Microsoft Corporation ISBN: 978-0-7356-4871-5 First printing: January, 2012 To ensure the ongoing accuracy of this book and its companion content, we ve reviewed

More information

BAMSI 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 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 information

Logging in. To start editing your committee or group s web page, you will first need to log in. To log in, go to this web page:

Logging in. To start editing your committee or group s web page, you will first need to log in. To log in, go to this web page: Logging in To start editing your committee or group s web page, you will first need to log in. To log in, go to this web page: http://austinuu.org/wp2011/wp-admin/ You should see the following on your

More information

Style Guide for Voting System Documentation

Style Guide for Voting System Documentation NISTIR 7519 Style Guide for Voting System Documentation Dana E. Chisnell UsabilityWorks Susan C. Becker Codewords Sharon J. Laskowski Information Access Division Information Technology Laboratory National

More information

Acta Guidelines for manuscript preparation

Acta Guidelines for manuscript preparation Acta Guidelines for manuscript preparation Guidelines for authors Manuscripts for submission to APE must be organized as follows: Title page (Title, Authors, Affiliations, Conflicts of interest, Institutions,

More information

In this Author s Guide, you will find information about how to submit a proposal, requirements, copyright, compensation, and more.

In this Author s Guide, you will find information about how to submit a proposal, requirements, copyright, compensation, and more. Author s Guide INTRODUCTION Dear Readers and Potential Authors: We are always looking for terrific articles project articles, articles on theory/technique, etc. to showcase. We publish articles written

More information

FACULTY OF ENGINEERING SCIENCE. Written and oral reporting Guidelines for engineering students

FACULTY OF ENGINEERING SCIENCE. Written and oral reporting Guidelines for engineering students FACULTY OF ENGINEERING SCIENCE Written and oral reporting Guidelines for engineering students Contents 1 Written communication... 4 1.1 Basic steps in the writing process... 5 1.2 Report writing: structure

More information

Notes For Making an NTI Toolkit revised

Notes For Making an NTI Toolkit revised Notes For Making an NTI Toolkit 1.29.2007 revised General Style Notes NTI terms Use acronym NTI; not NTICCHC, and do not include the before NTI Refer to graduates and those in training as NTI Trainers

More information

Stat 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) 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 information

Top Posts from the Zen Comma Blog, Edition 1

Top Posts from the Zen Comma Blog, Edition 1 Top Posts from the Zen Comma Blog, Edition 1 http://zencomma.wordpress.com Table of Contents Introduction: What Do Commas Do? 2 Most Common Comma Errors A Serial Comma Creates Confusion Comma with But

More information

How To Write Maintainable Engineering Specifications. Forrest Warthman

How To Write Maintainable Engineering Specifications. Forrest Warthman 1 How To Write Maintainable Engineering Specifications Forrest Warthman 2 Outline Motivations and audience Editing and vector-graphics tools Document formats and templates Inserting figures and tables

More information

Document and Web design has five goals:

Document and Web design has five goals: Document and Web design has five goals: to make a good impression on readers to help readers understand the structure and hierarchy of the information to help readers find the information they need to

More information

Make It Clear Introduction

Make It Clear Introduction Make It Clear Introduction The National Council for the Blind of Ireland (NCBI), the National Association for Deaf People (NAD) and the National Adult Literacy Agency (NALA) have created common guidelines

More information

Some writing guidelines

Some writing guidelines This style guide offers general information on writing, punctuation, word usage, and a number of other issues that have come up as we read and edit copy submitted to us for publication in Virginia Lawyer

More information

Evaluation Department, Danida. Layout guidelines for evaluation reports

Evaluation Department, Danida. Layout guidelines for evaluation reports Layout guidelines for evaluation reports January 2016 1 1. Introduction These guidelines provide guidance on how to improve the presentation of findings (Section 2), and the layout to be applied to the

More information

Journal Text Styles:

Journal 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 information

Stylesheet Studies in the Linguistic Sciences: Illinois Working Papers

Stylesheet 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 information

Author s Guide. 111 Founders Plaza, Suite 300 East Hartford CT USA P F

Author s Guide. 111 Founders Plaza, Suite 300 East Hartford CT USA P F Author s Guide INTRODUCTION Dear Readers and Potential Authors: Circuit Cellar, Inc. and Segment LLC are hereafter referred to collectively as the Publisher. The Publisher publishes Circuit Cellar magazine,

More information

Style template and guidelines for SPIE Proceedings

Style 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 information