Technical Writing Process

Technical Writing Process

Author: Kieran Morgan

Publisher: Technical Writing Process

Published: 2015

Total Pages: 0

ISBN-13: 9780994169310

DOWNLOAD EBOOK

"Plan, structure, write, review, publish"--Cover.


The Product is Docs

The Product is Docs

Author: Christopher Gales

Publisher:

Published: 2020

Total Pages: 287

ISBN-13:

DOWNLOAD EBOOK

This book provides a broad perspective about the essential aspects of creating technical documentation in today's product development world. It is a book of opinions and guidance, collected as short essays. You can read selectively about subjects that interest you, or you can read the entire collection in any order you like. Information development is a multidimensional discipline, and it is easy to theorize. We have written this book from our direct experience, using the concrete insights and practices we apply to our work every day. If you work as an information developer, a manager in a documentation team, or in another part of product development that collaborates with a doc team, there is information in this book for you. Perhaps you are a technical writer in a small, high-growth company that is figuring out its processes. Perhaps you are an information-development manager in a large enterprise company with an expanding product line and an ever more complex matrix of cross-functional dependencies. You might work at a medium-sized company where your management is asking you to do more with fewer people, and you want some additional perspective that will help you find a leaner and more effective way to deliver what your business demands. Or you might work outside the technical documentation world, in another part of product development, and are wondering how to collaborate most effectively with the documentation team. The purpose of The Product is Docs is to provoke discussion, shine light on some murky areas, and--we hope--inspire our colleagues to consider their processes and assumptions with new eyes. -- Amazon.


Document Design

Document Design

Author: Miles A. Kimball

Publisher: Bedford/St. Martin's

Published: 2007-12-12

Total Pages: 440

ISBN-13: 9780312436995

DOWNLOAD EBOOK

The technological revolution of the last ten years has radically changed document designers' materials, processes, and tools of the trade. In short, choices about everything from typography and color to planning and production have changed -- even multiplied. The first new text for the college market in ten years, Kimball and Hawkins' Document Design assumes from the start that students are working online to produce a fuller range of print and online documents, designed and delivered differently in a digital world. Through practical, accessible advice and examples, Kimball and Hawkins lay out the array of elements and choices that document designers need to consider, all in the context of a rhetorical framework that allows students to see the effects of those choices. The only text to integrate a range of theoretical perspectives, visual perception, visual culture, and visual rhetoric, Document Design teaches students to think more critically about their own design decisions and to keep usability in mind every step of the way. True to its message, this artfully designed text practices the principles it teaches and is sure to become a reference that students will keep.


Developing Quality Technical Information

Developing Quality Technical Information

Author: Michelle Carey

Publisher: Pearson Education

Published: 2014

Total Pages: 612

ISBN-13: 0133118975

DOWNLOAD EBOOK

Drawing on IBM's unsurpassed technical communications experience, readers discover today's best practices for meeting nine quality characteristics: accuracy, clarity, completeness, concreteness, organization, retrievability, style, task orientation, and visual effectiveness. Packed with guidelines, checklists, and before-and-after examples, Developing Quality Technical Information, Third Edition is an indispensable resource for the future of technical communication.


Technical Documentation and Process

Technical Documentation and Process

Author: Jerry C. Whitaker

Publisher: CRC Press

Published: 2018-09-03

Total Pages: 195

ISBN-13: 1439861609

DOWNLOAD EBOOK

We live in an age of electronic interconnectivity, with co-workers across the hall and across the ocean, and managing meetings can be a challenge across multiple time zones and cultures. This makes documenting your projects more important than ever. In Technical Documentation and Process, Jerry Whitaker and Bob Mancini provide the background and structure to help you document your projects more effectively. With more than 60 years of combined experience in successfully documenting complex engineering projects, the authors guide you in developing appropriate process and documentation tools that address the particular needs of your organization. Features Strategies for documenting a project, product, or facility A sample style guide template—the foundation on which you can build documents of various types A selection of document templates Ideas for managing complex processes and improving competitiveness using systems engineering and concurrent engineering practices Basic writing standards and helpful references Major considerations for disaster planning Discussion of standardization to show how it can help reduce costs Helpful tips to manage remote meetings and other communications First-hand examples from the authors’ own experience Throughout, the authors offer practical guidelines, suggestions, and lessons that can be applied across a wide variety of project types and organizational structures. Comprehensive yet to the point, this book helps you define the process, document the plan, and manage your projects more confidently.


The Insider's Guide to Technical Writing

The Insider's Guide to Technical Writing

Author: Krista Van Laan

Publisher: XML Press

Published: 2012-05-15

Total Pages: 512

ISBN-13: 1457182424

DOWNLOAD EBOOK

Every complex product needs to be explained to its users, and technical writers, also known as technical communicators, are the ones who do that job. A growing field, technical writing requires multiple skills, including an understanding of technology, writing ability, and great people skills. Whether you're thinking of becoming a technical writer, just starting out, or you've been working for a while and feel the need to take your skills to the next level, The Insider's Guide to Technical Writing can help you be a successful technical writer and build a satisfying career. Inside the Book Is This Job for Me? What does it take to be a technical writer? Building the Foundation: What skills and tools do you need to get started? The Best Laid Plans: How do you create a schedule that won’t make you go crazy? How do you manage different development processes, including Agile methodologies? On the Job: What does it take to walk into a job and be productive right away? The Tech Writer Toolkit: How do you create style guides, indexes, templates and layouts? How do you manage localization and translation and all the other non-writing parts of the job? I Love My Job: How do you handle the ups and downs of being a technical writer? Appendixes: References to websites, books, and other resources to keep you learning. Index


The IEEE Guide to Writing in the Engineering and Technical Fields

The IEEE Guide to Writing in the Engineering and Technical Fields

Author: David Kmiec

Publisher: John Wiley & Sons

Published: 2017-09-25

Total Pages: 198

ISBN-13: 1119070139

DOWNLOAD EBOOK

Helps both engineers and students improve their writing skills by learning to analyze target audience, tone, and purpose in order to effectively write technical documents This book introduces students and practicing engineers to all the components of writing in the workplace. It teaches readers how considerations of audience and purpose govern the structure of their documents within particular work settings. The IEEE Guide to Writing in the Engineering and Technical Fields is broken up into two sections: “Writing in Engineering Organizations” and “What Can You Do With Writing?” The first section helps readers approach their writing in a logical and persuasive way as well as analyze their purpose for writing. The second section demonstrates how to distinguish rhetorical situations and the generic forms to inform, train, persuade, and collaborate. The emergence of the global workplace has brought with it an increasingly important role for effective technical communication. Engineers more often need to work in cross-functional teams with people in different disciplines, in different countries, and in different parts of the world. Engineers must know how to communicate in a rapidly evolving global environment, as both practitioners of global English and developers of technical documents. Effective communication is critical in these settings. The IEEE Guide to Writing in the Engineering and Technical Fields Addresses the increasing demand for technical writing courses geared toward engineers Allows readers to perfect their writing skills in order to present knowledge and ideas to clients, government, and general public Covers topics most important to the working engineer, and includes sample documents Includes a companion website that offers engineering documents based on real projects The IEEE Guide to Engineering Communication is a handbook developed specifically for engineers and engineering students. Using an argumentation framework, the handbook presents information about forms of engineering communication in a clear and accessible format. This book introduces both forms that are characteristic of the engineering workplace and principles of logic and rhetoric that underlie these forms. As a result, students and practicing engineers can improve their writing in any situation they encounter, because they can use these principles to analyze audience, purpose, tone, and form.


Technical Writing One Hundred One

Technical Writing One Hundred One

Author: Alan S. Pringle

Publisher: Lulu.com

Published: 2009

Total Pages: 330

ISBN-13: 0970473362

DOWNLOAD EBOOK

Details the skills you need as a technical writer to create both printed and online content. This valuable reference describes the entire development process-planning, writing, visual design, editing, indexing, and production. You also get tips on how to write information that is more easily translated into other languages. You'll learn about the importance of following templates and about how structured authoring environments based on Extensible Markup Language (XML) streamline the content development process. This updated third edition features new information on the Darwin Information Typing Architecture (DITA) standard for structured authoring, and it explains the impact of Web 2.0 technologies-blogs, wikis, and forums-on technical communication.


The Complete Idiot's Guide to Technical Writing

The Complete Idiot's Guide to Technical Writing

Author: Krista Van Laan

Publisher: Alpha Books

Published: 2001

Total Pages: 333

ISBN-13: 9780028641461

DOWNLOAD EBOOK

Covers the field of technical writing, providing information on such topics as building a portfolio, writing an effective resume, finding well-paying jobs, passing a writing exam, and creating a document online.