Style Guides
Links for technical writers and others who create technical documentation and software documentation: style guides
On this page:
Writing enhancement and proofreading in general
Microsoft Writing Style Guide The most frequently used style guide for software documentation. Replaces the Microsoft Manual of Style and is now free of charge. https://docs.microsoft.com/en-us/style-guide/welcome/ Simplified Technical English Here you can request a free copy of the ASD-STE100 Specifcation. This document contains many good writing tips and rules that can be applied to any project. http://www.asd-ste100.org/request.html Apple Publications Style Guide Complete, downloadable style guide in PDF format (approx. 200 pages). To find the guide on the web site, enter “publications style guide” into the search box. Jorsek Content Development Style Guide Style guide from the manufacturer of the easyDITA content management system. https://github.com/Jorsek/jorsek-cdg Salesforce Style Guide Comprehensive style guide for documentation and user interface text. Can also be downloaded as a PDF (approx. 110 pages). Google Developer Documentation Style Guide Addresses some general topics, such as writing for a global audience, plus language, grammar, punctuation, and various writing conventions. https://developers.google.com/style/ GNOME Documentation Style Guide Writing style guide specifically for writing software documentation. https://developer.gnome.org/gdp-style-guide/ SUSE and openSUSE Style Guides Style guides for documentation and texts within the user interface. https://doc.opensuse.org/products/opensuse/Styleguide/opensuse_documentation_styleguide_sd/ Drupal Handbook Style Guide Brief guide with some basic tips. https://www.drupal.org/governance/documentation-policies Wikipedia Manual of Style Brief style guide for writing wiki entries. https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style IEEE Computer Society Style Guide Comprehensive style guide, published by the Institute of Electrical and Electronics Engineers’ Computer Society. https://www.computer.org/portal/web/publications/styleguide National Geographic Style Manual Detailed guide to the preferred National Geographic Society style. https://sites.google.com/a/ngs.org/ngs-style-manual/ Web Style Guide Comprehensive style guide and textbook on online information design in general. Writing Styleguide and Dictionary of Plain English List of frequently abused and overblown words and their plain English equivalents (PDF, 19 pages). Go to the “Publications” section. The Elements of Style Well-known, brief, classic reference. |
OWL Online Writing Lab Collection of handouts and exercises on general writing concerns, grammar, spelling, punctuation, and professional writing. https://owl.english.purdue.edu/ Plain English Campaign Collection of free guides in PDF format. http://www.plainenglish.co.uk/free-guides.html Plain Language Action and Information Network Collection of resources that are aimed to help you write more clearly and more concisely. Sharpening Your Writing Skills Gives away two free booklets in PDF format: “Writing Styleguide and Dictionary of Plain English” and “Sharpening Your Writing Skills—A Workshop for Business and Technical Writers.” For the download, go to the “Publications” section. https://www.techcommunicators.com Proofreaders’ Marks Brief reference of proofreader’s marks. |
Did you benefit from this guide? Did it save you some time compared to search via Google or other search engines? Please help me to keep the guide free and up to date also in the future. Buy a copy of the PDF version (approx. 120 pages).
Thank you.
This page was last updated 02/2019
Legal Notes:
This page may contain paid advertisements, which are marked as such. Apart from this, the linked web sites and their publishers are not associated with or endorsed by indoition Technical Communication Services Marc Achtelig, and do not reflect the opinion of indoition Technical Communication Services Marc Achtelig. Copyright of linked materials by their respective copyright holders. Note the license terms given on the linked pages! Any pricing and licensing information given on this page is only for prior information and without guarantee.