http://tc.eserver.org/dir/Reference/Style-Guides A listing of the most recently indexed works about Reference and Style Guides in the field of technical communication. en-us Copyright (c) 2005-08 by the EServer. All rights reserved. tclib-editorial@eserver.org (TC Library Editorial Board) webmaster@eserver.org (Geoffrey Sauer) http://tc.eserver.org/images/newlogo.gif http://tc.eserver.org/dir/Reference/Style-Guides http://tc.eserver.org/34550.html http://tc.eserver.org/34550.html This introduction to legal citation is focused on the forms of citation used in professional practice rather than those used in journal publication. It aims to identify the more important points on which there is divergence between the rules set out in two common manuals and evolving usage reflected in legal memoranda and briefs prepared by practicing lawyers. http://tc.eserver.org/34159.html http://tc.eserver.org/34159.html This set of guidelines was developed to help you understand the expectations for technical communication in CE 314K (Properties and Behavior of Engineering Materials). Successful technical communication requires practice. Therefore, you should allot sufficient time to write several drafts of each assignment before submitting the final version. http://tc.eserver.org/31676.html http://tc.eserver.org/31676.html Some people write well but allow themselves to be disabled by a fear of punctuation and grammar. They know how to prewrite, organize, and revise, but proofreading for punctuation and grammar causes them difficulties. There’s no need to fear these conventions of standard written English. In fact, these conventions can help you become a more effective communicator. http://tc.eserver.org/26195.html http://tc.eserver.org/26195.html A one-page reference card for DocBook elements. http://tc.eserver.org/25797.html http://tc.eserver.org/25797.html Confusing Words is a collection of words that are troublesome to readers and writers. Words are grouped according to the way they are most often confused or misused. http://tc.eserver.org/25798.html http://tc.eserver.org/25798.html This site is dedicated to answering grammar, composition, or formatting questions. http://tc.eserver.org/24671.html http://tc.eserver.org/24671.html The development and dissemination of new communication standards and guidelines are evolving processes that require cooperation, teamwork, and clear communication. http://tc.eserver.org/24117.html http://tc.eserver.org/24117.html This outline is provided to help introduce the Technical Report and to clarify the acceptable format and level of achievement that is considered essential for successful completion of the Technical Report. http://tc.eserver.org/24076.html http://tc.eserver.org/24076.html This guide is based on the style book which is given to all journalists at <i>The Economist</i>. http://tc.eserver.org/24018.html http://tc.eserver.org/24018.html Internet addresses have been proliferating in publications, and they're not going to go away. Editors unfamiliar with the Net may see these addresses as incomprehensible blocks of characters that can't be understood or analyzed into components. But learning a little about their structure can help prevent you from publishing erroneous addresses. http://tc.eserver.org/23963.html http://tc.eserver.org/23963.html The GNOME Documentation Style Guide provides guidelines for authors who want to contribute to the GNOME Documentation Project. http://tc.eserver.org/23959.html http://tc.eserver.org/23959.html How does your writing style affect localization? The following list of suggestions provides some language and terminology guidelines that should ease localizing your application. http://tc.eserver.org/23901.html http://tc.eserver.org/23901.html Provides alternatives to overstated, pompous words; wordy, bureaucratic phrases; and verbose, sometimes amusing redundant phrases. http://tc.eserver.org/23899.html http://tc.eserver.org/23899.html This manual mostly follows Associated Press style but also follows advice of other excellent books on writing and Web sites listed in Garbl's Writing Resources Online -- and my selection and interpretation of their guidelines. This guide focuses on U.S. standards for spelling, punctuation, definitions, usage, style and grammar. http://tc.eserver.org/23910.html http://tc.eserver.org/23910.html This paper describes the types of terms that you should include in software product glossary and describes how to write definitions for these terms. It also describes a method for controlling word usage and managing terminology for software projects. http://tc.eserver.org/23813.html http://tc.eserver.org/23813.html This pamphlet is designed to introduce you to, or remind you of, the basic principles of prose style and mechanics. The Prose Style Section describes twelve basic principles of good prose style and illustrates most of these principles with examples. Since most writers and editors agree about the importance of these twelve basic principles, I have drawn from a wide variety of sources. However, I would especially recommend two texts: The Elements of Style by William Strunk and E.B. White and Style: Ten Lessons in Clarity & Grace by Joseph Williams. http://tc.eserver.org/23726.html http://tc.eserver.org/23726.html Information on style, grammar, and usage. http://tc.eserver.org/23503.html http://tc.eserver.org/23503.html Language Across the Curriculum in Applied Science and Engineering at the University of Toronto helps students to communicate in writing and orally. http://tc.eserver.org/23502.html http://tc.eserver.org/23502.html The rules here apply to all classes in the Chemical Engineering Department at Ohio University. Most of them will apply in 'the real world', too, although your employer may have some specific format requirements. http://tc.eserver.org/21661.html http://tc.eserver.org/21661.html The following is a description of Florida Institute of Technology's in-house writing style for everything except technical papers and reports. This guide is set up alphabetically and contains listings that will allow you to standardize everything you write for the university. Reference materials include The Associated Press Stylebook And Libel Manual (Fully Revised and Updated 1998 Edition), Webster's Ninth New Collegiate Dictionary and McGraw-Hill Dictionary of Scientific and Technical Terms (Fourth Edition). http://tc.eserver.org/21628.html http://tc.eserver.org/21628.html An annotated collection of links to the best and most up-to-date citation guides that show how to properly cite resources from the Internet. Style guides for APA, MLA, Chicago, Turabian, BSE, styles and a description of how to cite references from Lexis/Nexis. http://tc.eserver.org/21592.html http://tc.eserver.org/21592.html Complete styles and guidelines for publishing a variety of technical publications. http://tc.eserver.org/21349.html http://tc.eserver.org/21349.html The format for citations to legal materials is different from the format for scholarly citations to books and periodicals in general. This handout is a terse guide to legal citation in the USA. The generally accepted style manual for legal citations in the USA is the Bluebook: A Uniform System of Citation, which is published by the editors of four prestigious law reviews at Columbia University, Harvard, Univ. of Pennsylvania, and Yale Law Schools. A copy of theBluebook can be purchased in any law school bookstore. A comprehensive set of rules from the Bluebook is available on the Internet from Peter W. Martin at Cornell Law School. In contrast, this handout here contains a terse set of rules that agree with the Bluebook, but does not contain all of the fine points and options in the Bluebook. Opinions of some courts use a different format from the Bluebook, but these alternative citation formats contains the same information. Be aware that citations in opinions of state or federal courts may not be the correct bibliographic style according to the Bluebook.Furthermore, the proper format according to the Bluebook changes with time, so old sources (both cases and law review articles) do not use the modern format for citation. http://tc.eserver.org/20712.html http://tc.eserver.org/20712.html Style manuals show how to format bibliographies and footnotes; some also provide information on outlining, editing and writing. If your instructor has not specified a particular format or recommended a style manual, consult one of the following, widely-used manuals. http://tc.eserver.org/19769.html http://tc.eserver.org/19769.html A sample research paper, formatted using the CBE Style Guide. http://tc.eserver.org/19768.html http://tc.eserver.org/19768.html A sample research paper, formatted using the Chicago Style. http://tc.eserver.org/19711.html http://tc.eserver.org/19711.html The May 2003 edition of the standard reference for Apple publications. http://tc.eserver.org/18852.html http://tc.eserver.org/18852.html The formatting of citations recommended in this guide is based on Modern Language Association recommendations. This guide may suffice for most students' needs for most academic purposes, but for advanced research projects it is by no means a substitute for the Modern Language Association Handbook for Writers of Research Papers Fifth Edition (1999). That handbook can be purchased in most bookstores and copies should be available in every college and municipal library. A Guide similar to this one, but based on the APA style, is also available online (see link on the navigation bar). Your best source of advice on all these matters is, of course, your instructor and library professionals. http://tc.eserver.org/18414.html http://tc.eserver.org/18414.html Based on faculty concerns, this handbook offers guidelines and exercises to help you improve your technical style. http://tc.eserver.org/18296.html http://tc.eserver.org/18296.html When editors refer to style, they usually do not mean an individual's writing style; they mean editorial style—the guidelines a publisher uses to enhance the reader's understanding. Editorial style includes the consistent use of spelling, punctuation, capitalization, and abbreviations, as well as the selection of headings and the use of numbers. These guidelines are often called 'conventions' because they represent a conventional presentation used in publishing. http://tc.eserver.org/18301.html http://tc.eserver.org/18301.html As first-language English users we often need to communicate effectively with people for whom English is a foreign or a second language, for instance when conducting business internationally. The Internet, particularly, is a global medium of communication, and we cannot assume that everyone reads or understands English flawlessly. http://tc.eserver.org/15049.html http://tc.eserver.org/15049.html A sample research paper, formatted using the APA style guide. http://tc.eserver.org/15048.html http://tc.eserver.org/15048.html A sample research paper, formatted using the MLA style guide. http://tc.eserver.org/14475.html http://tc.eserver.org/14475.html This manual is intended to be used by any engineering student (undergraduate or graduate) who has to complete writing assignments or oral presentations for any course. You will find information on general principles of grammar and style, as well as specific examples of technical writing and presenting. If your communication assignment is for an engineering class, you will want to pay particular attention to the sample documents. http://tc.eserver.org/14189.html http://tc.eserver.org/14189.html This publication is directed toward professional writers, editors, and proofreaders. Those whose profession lies in other areas (for example, research or management), but who have occasion to write or review others' writing will also find this information useful. By carefully studying the examples and revisions to these examples, you can discern most of the techniques in my editing 'bag of tricks'; I hope that you editors will find these of particular interest. http://tc.eserver.org/14139.html http://tc.eserver.org/14139.html This document accompanies the TECHWR-L article '<A HREF="http://tc.eserver.org/14140.html">Developing a Style Guide</A>,' and includes a sample outline of a style guide. Some of the sections include some detailed sample text; others do not. Please note that the examples shown here are not necessarily the 'correct' choices, or the 'preferred' choices, or the 'best' choices; they are simply examples of things to include. Your project may require additional items, especially if your writing will be used on a Web site. http://tc.eserver.org/14062.html http://tc.eserver.org/14062.html Preferred editorial style for the preparation of proposed IEEE standards is established. Many of the frequently asked questions about writing drafts are answered. The optional and required contents of drafts are described, and instructions on submitting drafts for IEEE-SA Standards Board approval and publication are provided. This manual is not intended to be a guide to the procedural development of standards. http://tc.eserver.org/14008.html http://tc.eserver.org/14008.html La puntuación de los textos escritos, con la que se pretende reproducir la entonación de la lengua oral, constituye un capítulo importante dentro de la ortografía de cualquier idioma. De ella depende en gran parte la correcta expresión y comprensión de los mensajes escritos. La puntuación organiza el discurso y sus diferentes elementos y permite evitar la ambigüedad en textos que, sin su empleo, podrían tener interpretaciones diferentes. http://tc.eserver.org/14003.html http://tc.eserver.org/14003.html The information that follows addresses common student questions when preparing research papers using the APA writing format. Students are encouraged to consult the 5th edition of the Publication Manual of the American Psychological Association (APA) for more complete information and the Fischler Graduate School of Education and Human Services’ Style Guide for the Applied Dissertation (SGAD) for exceptions to APA. The summary also includes a few APA exceptions. http://tc.eserver.org/13965.html http://tc.eserver.org/13965.html We're pleased to offer some of the many instructional materials we've developed for our Writing Center teaching. As useful as we think these materials may be to you, though, we need to offer a few words of caution. There are limitations to these materials. Assignments vary. Different instructors want different things from student writers. What's appropriate and effective in one context, isn't necessarily so in others. So as you peruse what's here please understand that our suggestions may or may not apply to your writing situation. Please remember that handouts can give only a fraction of the customized guidance that an individual conference with a Writing Center instructor can provide. http://tc.eserver.org/13646.html http://tc.eserver.org/13646.html This is a list of resources related to language, including online reference tools like dictionaries and style guides. http://tc.eserver.org/13633.html http://tc.eserver.org/13633.html Originally prepared for students in the English Department at the University of Victoria, the Guide is an introduction to the process of writing and to the study of literature. We're pleased to make its hypertext version available to writers and students of literature across the World Wide Web. We hope you find it helpful whether you're just starting the big job of writing an essay or need only to check a small point. http://tc.eserver.org/13590.html http://tc.eserver.org/13590.html Many individuals and organizations develop style guides to provide standards for the development of publications. Style guides give rules and examples of writing style, word use, grammar, punctuation, capitalization, and typographic conventions. These standards are used when writing all kinds of documents—manuals, newsletters, reports, proposals, letters, memos, and so on—to maintain consistency and quality. Our style guide is organized alphabetically by keyword for quick reference. http://tc.eserver.org/13518.html http://tc.eserver.org/13518.html An updated version of the style guide used by writers and editors in Apple publications groups. http://tc.eserver.org/13404.html http://tc.eserver.org/13404.html Do you have a question about style, grammar, or mechanics? Find the answer to your questions in the Good Grammar, Good Style Archive — over 100 pages of useful articles and frequently asked questions! http://tc.eserver.org/13316.html http://tc.eserver.org/13316.html These notes are a miscellany of grammatical rules and explanations, comments on style, and suggestions on usage I put together for my classes. Nothing here is carved in stone, and many comments are matters of personal preference — feel free to psychoanalyze me by examining my particular hangups and bêtes noires. Anyone who can resist turning my own preferences into dogma is welcome to use this HTML edition. http://tc.eserver.org/13275.html http://tc.eserver.org/13275.html Suggestions for avoiding language that reinforces stereotypes or excludes certain groups of people. Includes examples of sentences and words to avoid, and replacements for them. Includes the following topics: Sexism, Race and Ethnicity, Age, Sexual Orientation, Depersonalization of Persons with Disabilities or Illnesses, Patronizing or Demeaning Expressions, and Language That Excludes or Emphasizes Differences. http://tc.eserver.org/11852.html http://tc.eserver.org/11852.html This site is a concise guide to some of the most commonly violated rules of writing, grammar, and punctuation. It is intended for all writers as an aid in the learning and refining of writing skills. Explore each of the rules to see examples of its application, and use the references to find additional explanations and examples on the Web or in print. Look up grammatical terms in the glossary. For a wider variety of information, check related FAQs and other writing resources. http://tc.eserver.org/11851.html http://tc.eserver.org/11851.html A guide on punctuation, capitals, spelling, sentence construction and parts of speech. http://tc.eserver.org/10867.html http://tc.eserver.org/10867.html This guide is intended for all writers of English at large, bureaucratic institutions. Our example here is the European Commission! Whether your job is drafting or translating, here are some hints - not rules - that will help you to write clearly and make sure your message ends up in your readers' brains, not in their bins. http://tc.eserver.org/10868.html http://tc.eserver.org/10868.html The traditional way of writing government documents has not worked well. Too often, it has produced complicated, jargon-filled documents that have resulted in frustration, lawsuits, and a lack of trust between citizens and their government. To overcome this legacy, the documents writers have a great responsibility to communicate clearly. Studies show that clearly written regulations improve compliance and decrease litigation. Writing that considers our readers' needs and draws them into the regulatory process improves the relationship between the government and the public it serves. Clear correspondence reduces the burden on the public. It also reduces the burden on the agency because we don't have to deal with the consequences of unclear communication. http://tc.eserver.org/10768.html http://tc.eserver.org/10768.html The Internet is a widely used tool for research, but unfortunately, style manuals contain little information on how to document electronic sources. This page contains links to sources which will help students, teachers, and anybody doing research on the Internet to cite such sources using different styles. Some links come from 'Cyber Citations,' an article by Michael A. Arnzen, which appeared in Internet World in September 1996. Some of the addresses were no longer current and are updated here, and many more have been added. http://tc.eserver.org/10766.html http://tc.eserver.org/10766.html For the most current information about APA Format, we recommend visiting the Author's Corner of the APA website, where you can read about electronic reference formats recommended by the American Psychological Association and some frequently asked questions about the APA Publication manual, which includes the most up to date information about formatting, citation, and style. This handout is currently being revised to be in accordance with the latest guidelines, so do make sure to check our information against theirs. http://tc.eserver.org/10767.html http://tc.eserver.org/10767.html Modern Language Association (MLA) format provides writers with a system for cross-referencing their sources--from their parenthetical references to their works cited page. This cross-referencing system allows readers to locate the publication information of source material. This is of great value for researchers who may want to locate your sources for their own research projects. The proper use of MLA style also shows the credibility of writers; such writers show accountability to their source material. Most importantly, the use of MLA style can protect writers from accusations of plagiarism--the purposeful or accidental use of source material by other writers without giving appropriate credit. http://tc.eserver.org/10715.html http://tc.eserver.org/10715.html A list of frequently used and sometimes misused words, their definitions and examples of their correct usage. http://tc.eserver.org/10711.html http://tc.eserver.org/10711.html Defines the functions of several punctuation marks and provides examples of their correct usage. http://tc.eserver.org/10712.html http://tc.eserver.org/10712.html Lists common phrases that make wordy documents and makes suggestions for replacing them. http://tc.eserver.org/10672.html http://tc.eserver.org/10672.html Explains English parts of speech and gives several usage examples. http://tc.eserver.org/10625.html http://tc.eserver.org/10625.html This book is designed to inform you about current problems in English usage so you can make intelligent decisions when communicating. When confronted with a choice about a usage, you may ask yourself a number of questions: Has this usage been criticized for some reason in the past? If so, are these criticisms substantial? What are the linguistic and social issues involved? Have people frequently applied this usage in the past, and for how long? What do well-respected writers think of the usage today? You will find answers to these and many other questions in this book. http://tc.eserver.org/10640.html http://tc.eserver.org/10640.html Jane Straus' easy-to-use reference guide and workbook is now available as an online resource. This popular book is an indispensable and entertaining guide for writers, proofreaders, editors, managers, clerical staff, teachers, and students. Use this site to find the answers to your questions concerning proper English grammar and punctuation. http://tc.eserver.org/10644.html http://tc.eserver.org/10644.html Offers an extensive list of commonly confused words, their definitions and the correct way to use them. http://tc.eserver.org/10655.html http://tc.eserver.org/10655.html A website about English grammar for students. http://tc.eserver.org/10652.html http://tc.eserver.org/10652.html A web-based complete guide to English syntax and grammar. http://tc.eserver.org/10650.html http://tc.eserver.org/10650.html International Standard ISO 8601 specifies numeric representations of date and time. This standard notation helps to avoid confusion in international communication caused by the many different national notations and increases the portability of computer user interfaces. In addition, these formats have several important advantages for computer usage compared to other traditional date and time notations. The time notation described here is already the de-facto standard in almost all countries and the date notation is becoming increasingly popular. http://tc.eserver.org/10615.html http://tc.eserver.org/10615.html The T-shirt, commonly misspelled 'tee shirt,' is so named because it resembles the letter T when spread out. Tee ball, commonly misspelled 'T-ball,' is so named because a ball is hit off a tee. Is that so difficult? Apparently it is. Unanimously, as far as I can tell, dictionaries favor the non-informative T-ball. Some of those dictionaries don't even recognize tee ball as an alternate spelling. Some very smart people think I'm out of my mind for having such strong feelings in favor of the tee- version. http://tc.eserver.org/10618.html http://tc.eserver.org/10618.html A style guide is essential for a successful project. Many of our clients have their own style guidelines, which we follow to ensure that our work matches what they produce in-house. However, some clients do not have internal style guides. We have developed our own style guide to ensure our work on their projects is consistent. Putting the style guide on the web eliminates distribution problems and ensures that we always use the latest version. http://tc.eserver.org/10591.html http://tc.eserver.org/10591.html Bill Walsh, a copy editor for the Washington Post, rants on style and usage topics. http://tc.eserver.org/10232.html http://tc.eserver.org/10232.html Asserting that one must first know the rules to break them, this classic reference book is a must-have for any student and conscientious writer. Intended for use in which the practice of composition is combined with the study of literature, it gives in brief space the principal requirements of plain English style and concentrates attention on the rules of usage and principles of composition most commonly violated. http://tc.eserver.org/10231.html http://tc.eserver.org/10231.html Writing Revisable Manuals–A Guidebook for Business and Government was written to help organizations prepare high quality manuals, quickly and inexpensively. There is a saying in technical writing that 'You can have it good, you can have it fast, or you can have it cheap. But you can’t have all three.' The goal of this guidebook is to show you how to have all three. Focusing on revisable manuals—the kind you can update easily—this guidebook takes you step-by-step through planning, writing, and producing manuals. If you are working on a manual for your organization, or will be in the near future, this guidebook is for you. http://tc.eserver.org/10177.html http://tc.eserver.org/10177.html A collection of links to reference information of all types. http://tc.eserver.org/10112.html http://tc.eserver.org/10112.html A guide to locating, translating, and using the elements of citation for both a humanities style (i.e., MLA and Chicago) and a scientific style (APA and CBE) for electronically-accessed sources. Part I is divided into two chapters. Chapter I examines, in broad and theoretical terms, the logic of citation; it answers the questions, 'Why cite?' and 'Why use a citation style?' Chapter 2 answers the question, 'How should we cite online material?' It first provides a guide to citation for authors working with humanities-oriented texts and then discusses an author-date citation system typically used in the sciences. Part 2 includes four chapters. Chapter 3 discusses the logic–the why–of document style. Chapters 4 and 5 describe standards for how to produce print and online documents. Chapter 6 discusses some more advanced considerations related to online style (3-4). http://tc.eserver.org/10042.html http://tc.eserver.org/10042.html When writing for the Web, the documents usually become part of a larger collection. It's important that the site follows a common structure so all documents are available in a logical place. For a document, the style is also very important. By using a common style, you ensure that a reader can use the site effectively. Some important aspects are indicating the status of the document, using images and icons, and writing in a device-independent way.