Home
Class notes
Resources |
|
Hundreds of books and articles offer advice on a variety of editing issues. These are among the most useful for technical communicators.
|
|
| Career Resources | |
| Dictionaries | Indexing |
| Editing/Writing | Project Management |
| Editing Tests | Style Guidelines |
| Fiction Editing | Working with Writers |
| Freelance Editing | Usability |
Style Guidelines |
|
| AIP Style Guide | Guidelines from the American Institute of Physics, downloadable in PDF format |
 Apple Publications Style Guide (PDF file) |
Style and usage guidelines for Apple products, training programs, instructional and reference materials |
| Chicago Manual of Style FAQ | Common questions addressed to the editors of the Chicago Manual |
| Developing a Departmental Style Guide | Discusses the purposes of a style guide and guidelines for what should (and should not) be included, whether to develop one or more style guides, and how detailed the style guide should be. Includes a sample style guide outline. |
 Dynamic Style Guides (PDF file) |
How to use macros, templates, and reference materials that guide writers as they work (Intercom, March 200) |
|
E-What? A Guide to the Quirks of New Media Style and Usage (Amazon) |
Style guide that includes common style issues (capitalization, abbreviations, etc.), a brief guide to Web writing, a 50-page word list of Internet-related terms, and advice on creating your own style guide. |
| The Economist magazine style guide | Covers capitalization, punctuation, spelling, abbreviations, and titles |
|
Example style guide (PDF) |
Sample guide to accompany article Developing a Departmental Style Guide |
| IEEE Standards Style Manual (2000) | Style guide for the Institute of Electrical and Electronics Engineers; covers tables, figures, mathematical expressions, notes, word usage, numbering, and document structure |
| Industry-specific style manuals | A list of standard style guides for specific industries including biology, chemistry, engineering, law, math, and psychology |
|
Includes Strunk’s Elements of Style, Yahoo’s guidelines, and Modern Language Association style guidelines |
|
|
Widely used style guide for technical content. You can download the entire guide from this location. |
|
|
Public Communications style guide (UC Davis) |
Guidelines used by the Public Communications department at the University of California-Davis |
| The U.S. Government Printing Office Style Manual 2000 | Guidelines for publications printed by the U.S. Government |
|
Style guide for the “digital age” compiled by copyeditors at Wired magazine |
|
|
Covers graphic design, editorial style as well as page design and navigation |
|
Dictionaries |
|
| Acronym Finder | Definitions of more than 337,000 acronyms, abbreviations, and initialisms |
|
Popular online dictionary, with links to other resources and a language discussion forum |
|
|
Links to 50+ online dictionaries, including special interest (e.g. accounting) and foreign language sites |
|
|
Searchable online database of thousands of technical terms. Includes a comprehensive list of file name extensions |
|
|
Online dictionary for computer and Internet technology |
|
Grammar |
|
|
Covers grammar, style, word choice, gender, and more |
|
|
Lists most common spelling and usage errors |
|
|
Common questions submitted to BCC Writing Center |
Answers to questions about grammar, punctuation, style, and more submitted by BCC writing students. |
| Confused words | Explains when to use commonly confused words (like "affect" and "effect"), with examples |
| Grammar Lady Online | Columns, tips, and a message board for getting help with grammar questions. |
| Grammar, Punctuation, and Capitalization | Handbook for writers and editors, from NASA; also available in PDF format (108 pages) |
|
Includes interactive quizzes, form for submitting questions. Covers paragraph and sentence levels. Well-written, entertaining, useful, and comprehensive |
|
| HyperGrammar | Online grammar course from the University of Ottawa; covers parts of speech, parts of a sentence, spelling, and paragraph structure |
|
Covers writing, grammar, and usage; from Purdue University |
|
|
Interactive writing textbook. Covers grammar, usage, writing. Includes quizzes. |
|
|
Interactive text book with step-by-step lessons and quizzes |
|
Usability |
|
|
Designing Web Usability: The Practice of Simplicity (Amazon) |
Guidelines for page design, site design, writing, and accessibility based on usability research Nielsen carried out at Sun. Covers much of the same material as his online articles on www.alertbox.com. |
|
1400+ links about information architecture, human factors, user interface issues, and usable design specific to the Web |
|
|
|
Editing/Writing |
|
100 Writing Remedies: Practical Exercises for Technical Writing (Amazon) |
Helpful guide for editors and writers aimed at fixing common writing problems |
|
21st Century Grammar Handbook (Amazon) |
Princeton Language Institute’s guide to modern grammar |
|
Annotated list of useful reference books |
|
| Book design for technical writing | Explains the content, style, format, design, and sequence of the various typical components of a book. |
| Copyeditor's Handbook | The first chapter from this book discusses the tasks that copyeditors are responsible for, levels of edit, process, and estimating time. |
| Definitions of editing services | Detailed explanation of different kinds of editing, including developmental, production, acquisitions, and project editing; also covers indexing and information design (from the Bay Area Editors' Forum) |
|
Developing New Levels of Edit (PDF) |
Revision of the original levels of edit framework, designed to simplify the editing process, focus editing on improving technical clarity, and ensure the value added by editing. |
|
Developing Quality Technical Information (Amazon) |
Practical guide for writers and editors |
| Editing and Proofreading Strategies | A list of what to look for, from Purdue University Writing Lab |
|
Tips for substantive editors and copyeditors working on Web content; covers scannability, navigation, links, and online writing style |
|
|
Annotated list of many useful sites about editing, writing, style and usage |
|
|
|
Sample of articles and tips from the Editorial Eye, a newsletter for editors. Also see the book Stet Again: More Tricks of the Trade for Publications People, from the same publisher. |
| EServer TC Library | Database of thousands of articles for technical communicators, maintained by the University of Washington; categories include editing, information design, web design, language, and science writing |
|
How to Write Usable User Documentation (Amazon) |
Practical guide to writing modular documentation |
|
Links to articles and presentations about using Word's Revision Tracking features to edit text online. |
|
| Plain Language Action Network | Resources to help writers achieve the goal of clear communication. Includes how-to articles, a guide for writing user-friendly documents, and examples of Plain Language documents. |
|
Lists of the skills and knowledge needed for editing at each level (structural and stylistic, copyediting, proofreading); from the Editors’ Association of Canada |
|
| Proofreading and Editing Symbols | Marks and abbreviations used in hardcopy editing |
| Redundant Phrases | Alphabetized list of redundant phrases and their non-redundant equivalents; also see the lists of wordy phrases and long words |
| Society for Technical Communication (STC) | Organization of more than 25,000 technical editors, writers and other professional technical communicators; website includes articles, job postings, and membership information |
| STC Newsletter Archives | Bi-monthly newsletter from the Puget Sound chapter of the Society for Technical Communication; includes advice on writing, editing, and career development. |
|
Site for copy editors |
|
|
Index of articles on a wide variety of topics of interest to technical editors |
|
| Technical Editor articles | Practical advice from the archives of the newsletter Corrigo, from the Technical Editing special interest group (SIG) of the Society for Technical Commumnication. |
| Technical Editing textbook | Companion website to textbook used in class; includes worksheets, presentations, editing exercises, and Web resources |
| Working with a Technical Editor | The basics of technical editing, addressed to new technical writers |
| Writing advice | Handouts from Hunter College's Reading/Writing Center; covers the writing process, grammar, and business writing |
|
Compilation of writing and navigation guidelines from Jakob Nielsen |
|
|
Describes key points of paragraph development including topic sentences, unity, and coherence. Interactive exercises. |
|
Indexing |
|
|
The Art of Indexing (Amazon) |
Useful book for beginning indexers |
|
Indexing Books (Amazon) |
University of Chicago indexing guidelines |
Graphics |
|
|
Envisioning Information (Amazon) |
Classic source for understanding graphics |
| Glossary of terms | Easy-to-understand definitions of graphic design and Web design terms, with examples and links |
| Graphics and Web Design Based on Edward Tufte's Principles | Outline of Tufte’s ideas |
|
The Icon Book: Visual Symbols for Computer Systems and Documentation/Book and Disk (Amazon) |
Useful book for understanding how to use icons effectively |
|
Illustrating Computer Documentation (Amazon) |
Explains the elements of graphics and when and how to use graphics effectively online and on paper |
|
The Non-Designer’s Design Book (Amazon) |
Clearly explains the basic principles of graphic design and use of type |
|
Symbol Sourcebook: An Authoritative Guide to International Graphic Symbols (Amazon) |
Useful guide for understanding how graphics are used internationally |
|
The Visual Display of Quantitative Information (Amazon) |
Another Tufte masterpiece |
Working with Writers |
|
| Coaching Techniques for Working with Writers | Best practices for working effectively with writers |
|
Strategies for Working with Writers |
The authors use the Myers Briggs Type Indicator and Boundary Spanning assessments to show how understanding cognitive differences between editors and writers can improve their relationships. |
| The Technical Editor as Diplomat | An academic look at linguistic strategies for balancing clarity and politeness (requires STC membership) |
|
Working with Difficult People |
Explains why people can be difficult to work with and presents coping techniques (STC presentation) |
|
Working with Subject Matter Experts: Strategies to Gain Cooperation and Win Respect |
Strategies include seeking buy-in, increasing transparency and cross-functional teams, expressing expectations clearly, setting common goals and objectives, and making success a shared accountability |
Project Management |
|
|
|
Overview of the purpose, contents, and development of a documentation plan and its role in successful project management |
| Estimating Editorial Tasks: A Five-Step Method | Process for estimating how long a project will take to edit |
|
Managing Your Documentation Projects (Amazon) |
Useful project management information |
|
Covers the major issues to consider, from the Technical Editors' Eyrie |
|
| Project Management resources for technical communicators | Worksheets and how-to articles about staffing, budgeting, and scheduling tech comm projects |
|
Useful discussion of how to estimate how long writing and other tasks will take in a technical documentation project |
|
Career Resources for Editors |
|
|
American Society of Business Publications Editors: Job Connection |
Links to job listings for a variety of trade-magazine publishing companies |
|
Articles on training, resumes, interviewing, and career development |
|
|
Qualities that Web writers and editors need to succeed; sample job descriptions and useful links |
|
| Copy Editor Job Board | Searchable list of editing jobs, sponsored by Copy Editor newsletter |
| Craig's List Seattle—writing/editing jobs | Regularly updated job postings in the Seattle area |
|
Defines a wide variety of job titles for writers and editors |
|
| Interview questions | Questions for technical writing positions, most of which apply to editing as well; also see this checklist |
|
Job listings and resources for writers and editors |
|
|
Advice and articles about resumes, interviewing, changing careers, and training. Search for job postings for “editors.” |
|
|
Description of writing and editing jobs, including working conditions, qualifications, advancement opportunities, and job outlook, from the U.S. Dept. of Labor |
|
|
|
Results of annual surveys of salaries and benefits of technical writers and editors, conducted by the Society for Technical Communication |
| Technical editors' responsibilities | Job descriptions for a variety of technical editing positions, taken from real postings |
Freelance Editing |
|
| Code of Fair Practice | Online book defining ethical standards and contract guidelines for editorial freelancers and clients |
| How Much Should a Freelancer Charge? | Factors to consider in determining your rate |
| How Much Should I Charge? | Rates for freelance editing and writing for a variety of industries (advertising, technical, book publishing, business, newspapers, educational, magazines), from WritersMarket.com |
| Rates for editing services | Common fee ranges for copyediting, substantive editing, proofreading, writing, indexing, and project management, from the Editorial Freelancers Association |
Editing Tests |
|
|
American Copy Editors Society test
|
Sample questions asked by newsrooms around the country, from the American Copy Editors Society (ACES); the site also offers tips and advice for newspaper editors. |
 Book publisher copyediting test
(DOC file) |
Short article to be editing. See the instructions for this test. |
| Dow Jones copyediting test | Test given to applicants to the Dow Jones Newspaper Fund. |
| MBA editing test | Paragraphs containing 30 copyediting errors, with answers |
| Test Your Editing Skills | Short article containing copyediting errors; check your version against "corrected" version. |
Fiction Editing |
|
| Editing Fiction | Questions to consider when editing fiction; covers plot, pacing, setting, characterization, dialog, and point of view |
|
Editing Fiction: Do You Dare?
|
A comparison of technical and fiction editing |
| Editors on Editing: What Writers Need to Know about What Editors Do (Amazon) | A guide for editors and writers who want to understand the publishing process. Professionals write about the special demands and skills necessary for particular areas of expertise—mass market, romance, special markets, and more. |
| The Fiction Editor, the Novel, and the Novelist (Amazon) | The chairman and editorial director of St. Martin's Press discusses the art of editing fiction. |
|
Copyright © 2004 Mazzba Productions. All rights reserved.
|