eBook that provides a framework for ESL authors to write professional documentation. An authoritative guide, its goal is to help authors to write consistent documentation, so that both technical experts and end users can benefit from common structures and conventions in written manuals and documents. The 203-page book includes 12 Chapters, 7 Appendices, and a section on basic principles written in Chinese. The comprehensive reference work includes a bibliography of useful style guides and dictionaries.
Technical Writing for Non-Native English Speakers discusses the basic principles of clear, concise technical writing, and it is directed at authors of all levels of experience. The book stresses internal consistency of format, style, and content, so that all users can derive the maximum benefit from corporate technical documentation. The guide also provides standards for common terms and concepts. In all phases of product development, from system design to documentation, consistency is a virtue. When writing technical documentation, authors should try to follow these guidelines as closely as possible.
* Chapter 1) Fundamental Concepts of Technical Documentation-introduces basic concept of technical documentation
* C2) Basic Building Blocks of Information Design-describes how to use different types of information structures
* C3) Grammar and Usage Guidelines-provides advice and examples about how to use specific parts of English grammar correctly
* C4) Writing Documentation for an International Audience-provides guidelines on how to handle the most common problems encountered by translators
* C5) Ways to Improve Your Documentation-outlines some tips about how you can review and improve your writing
* C6) Essential Details to Consider When Writing-use of units with numbers, common misuse of words in English, hyphens, tense, voice, etc.
* C7) Indexing Documentation-describes basic index requirements and indexing techniques
* C8) Writing for GUIs-describes how to write about user interfaces
* C9) Usability and Readability Considerations for Technical Documentation-discusses readability issues and provides methods to assess readability
* C10) Writing Accessible Documentation-discusses the needs of non-native English speaking users of technical documentation
* C11) Use of Screenshots-provides style guidelines for screenshots
* C12) Legal Topics-covers essential legal topics in technical documentation
* Appendix A) Recommended Terminology-provides a comprehensive list of suggested terminology for use in technical documentation
* AB) Units-provides a list of standard units that frequently appear in technical documentation or in product software
* AC) Glossary of Terms in this Guide-provides a list of unfamiliar language terms that are used in this guide
* AD) Examples of Information Design Building Blocks-provides examples of the information design building blocks discussed in Chapter 2
* AE) Abbreviations I-list I of telecom computer industry abbreviations
* AF) Abbreviations II-list II of telecom computer industry abbreviations
* AG) Self-Test Quizzes and Key-205 multiple-choice questions to test yourself on this guide’s contents
“This book has been written specifically for the thousands of non-native English speakers who must write technical documentation daily,” stated Ken Tidwell of Min-U Guides. “Employing these guidelines appropriately will ensure that your manual or documentation is consistent in layout, style, and content and that your writing is clear and concise, easily translated if necessary.”
* iPad, iPhone (3G or later), or iPod touch (2nd generation or later)
* iOS 4.3.3 or later
* Requires iBooks 1.3.1 or later
* 3.9 MB
Pricing and Availability:
Technical Writing for Non-Native English Speakers is $14.99 (USD) and available worldwide exclusively through the iTunes Store in the Books/Reference category. Review copies are available on request.
Located in beautiful Portland, Oregon, the Min-U Guides team is an independent software company founded by Ken Tidwell in February of 2009. With over three decades developing software, Ken’s goal is to provide user guides, manuals, and tutorials for a broad range of products while leveraging the unique Mac/iOS platforms. Copyright (C) 2012 Ken Tidwell. All Rights Reserved. Apple, the Apple logo, iPhone, iPod, and iPad are registered trademarks of Apple Inc. in the U.S. and/or other countries. All other trademarks may be the property of their respective owners. e eBook Conventions iOS