Handbook of Technical Writing

Handbook of Technical Writing
Author: Charles T. Brusaw
Publisher: St. Martin's Press
Total Pages: 832
Release: 1997-08-15
Genre: Technology & Engineering
ISBN: 9780312166908

New to this edition: Up-to-date information on on-line research and computer resources. A unique four-way access system enables users of the Handbook of Technical Writing to find what they need quickly and get on with the job of writing: 1. The hundreds of entries in the body of the Handbook are alphabetically arranged, so you can flip right to the topic at hand. Words and phrases in bold type provide cross-references to related entries. 2. The topical key groups alphabetical entries and page numbers under broader topic categories. This topical table of contents allows you to check broader subject areas for the specific topic you need. 3. The checklist of the writing process summarizes the opening essay on "Five Steps to Successful Writing" in checklist form with page references to related topics, making it easy to use the Handbook as a writing text. 4. The comprehensive index provides an exhaustive listing of related and commonly confused topics, so you can easily locate information even when you don't know the exact term you're looking for.

Document Design

Document Design
Author: Miles A. Kimball
Publisher: Bedford/St. Martin's
Total Pages: 440
Release: 2007-12-12
Genre: Language Arts & Disciplines
ISBN: 9780312436995

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.

Technical Writing Process

Technical Writing Process
Author: Kieran Morgan
Publisher: Boffin Education
Total Pages: 494
Release: 2024-02-29
Genre: Computers
ISBN: 0994169337

From the basics to advanced skills, the Technical Writing Process is your comprehensive guide to the art and science of crafting technical documentation. With eight core steps—Plan, Design, Write, Edit, Review, Translate, Publish, and Manage—this guide integrates both classical writing principles and the transformative potential of modern tools like AI. This book is more than a guide; it's an invitation to embrace the art of writing instructions with the mentorship of our experienced technical writers. Whether you’re a novice writer or an industry stalwart aiming to refine your technical communication skills, this book offers a blend of tried-and-true methods with the power of new-age tools. AI, as a significant element of the modern toolkit, receives special attention, helping readers stay ahead of the curve. Features Insights from industry experts around the world Real-world case studies and examples Comprehensive chapters on techniques and concepts Downloadable templates* to support each step in the process *For exclusive discounts on our premium content, use the coupon code in this book. About the Authors Our writing team, composed of top-notch technical writers, translation experts, and technical documentation managers from around the world, has pooled their experience and insights to help you succeed in your technical writing career. Praise for the First Edition “Every aspiring author / tech writer in college should have this book.” Steve Ballard, Manager, Enterprise Content Solutions “This is exactly the sort of guide I wish I had when I first started tech writing.” Sharon Witheriff, Technical Writer “The Technical Writing Process is a practical toolkit that demystifies the art of technical writing with useful templates to help you succeed quickly and smartly.” Richard Kidd, General Manager “Aspiring writers throughout the enterprise will find this to be a solid resource as they try to figure out how they should go about documenting something. It's logically laid out, not too heavy on jargon, and uses good diagrams and illustrations.” Duane Green, Sr. Director of Content Strategy Solutions “I think this pragmatic approach is excellent and fills a desperate need in the tech writing world. Many a point raised will have the older hands nodding sagely and the younger people remembering the advice when they first run into those issues.” Dr Charlotte Nash-Stewart, Engineer, Author, and Technical Writer “This is a well-written, comprehensive and practical guide for technical writers. It is packed full of great information and is very easy to read. I particularly like the ‘Insights,’ ‘What does that mean?’ and ‘Tips’ callouts which appear throughout the book.” Sue Geercke, Director Technical Communications “Technical Writing Process explores the essential elements any technical writer should consider when tackling their next assignment. The book systematically guides the reader through an intuitive, yet effective, methodology that spans everything from Planning to Publishing.’ Shay Withnell, Product Marketing Manager “Technical Writing Process is the professionalisation of the technical writing discipline. It rightly considers the holistic context for a technical document and provides a comprehensive cookbook for getting it right within an organisation. The insights, examples and templates are perfect and pragmatic. The definitive standard in technical writing.” Rami Banna, Product Lead “This book serves as a great reference to someone tasked with the technical writing aspect of a project. It would have saved me much heartache and a considerable amount of time if I had this information at the start of my project.” Keo Phetsaya, Technical Sales Manager

Cloud Native Infrastructure

Cloud Native Infrastructure
Author: Justin Garrison
Publisher: "O'Reilly Media, Inc."
Total Pages: 159
Release: 2017-10-25
Genre: Computers
ISBN: 1491984279

Cloud native infrastructure is more than servers, network, and storage in the cloud—it is as much about operational hygiene as it is about elasticity and scalability. In this book, you’ll learn practices, patterns, and requirements for creating infrastructure that meets your needs, capable of managing the full life cycle of cloud native applications. Justin Garrison and Kris Nova reveal hard-earned lessons on architecting infrastructure from companies such as Google, Amazon, and Netflix. They draw inspiration from projects adopted by the Cloud Native Computing Foundation (CNCF), and provide examples of patterns seen in existing tools such as Kubernetes. With this book, you will: Understand why cloud native infrastructure is necessary to effectively run cloud native applications Use guidelines to decide when—and if—your business should adopt cloud native practices Learn patterns for deploying and managing infrastructure and applications Design tests to prove that your infrastructure works as intended, even in a variety of edge cases Learn how to secure infrastructure with policy as code

Effective Documentation

Effective Documentation
Author: Stephen Doheny-Farina
Publisher: MIT Press
Total Pages: 376
Release: 1988
Genre: Computers
ISBN: 9780262040983

"Best Collection of Essays", NCTE Awards for Excellence in Technical and Scientific Communication. Effective Documentation is a major sourcebook that offers technical writers, editors, teachers, and students of technical communication a wide variety of practical guidelines based on often hard to find research in the usability of printed and electronic media. The book's eighteen chapters provide a wealth of material on such topics of current interest as the writing of design manuals, research in cognitive psychology as applied to the design of user manuals, and the organizing of manuals for hierarchical software systems. Included are chapters by such well known scholars in the field as Philip Rubens, Robert Krull, Judith Ramey, and John Carroll. Effective Documentation reviews the advice offered by other "how to produce usable documentation" books, describing the different types of usability research and explaining the inherent biases of each type. It goes beyond the actual design of textual and/or electronic media to look at these designs in context, giving advice on effective management ("good management is a requisite of good writing"), on the relationship between document design and product design, and on how to find out who one's readers really are. Advances in the presentation of textual information are explained, with suggestions on how to improve the usability of individual sentences and the design of entire books. The concluding chapters discuss advances in the design and use of online information and offer valuable insights into the use of graphic information and the development and design of information communicated via electronic media. Stephen Doheny Farina is Assistant Professor of Technical Communication at Clarkson University. Effective Documentationis included in the Information Systems series, edited by Michael Lesk.

Writing by Design

Writing by Design
Author: Michael Greene
Publisher: Prentice Hall
Total Pages: 436
Release: 1992
Genre: Technical writing
ISBN:

This extremely well-illustrated guide gives technical professionals the skills needed to communicate with others. It progresses step by step through the process of effectively designing a document or presentation from initial conception through final completion -- including a special focus on electronic tools for communication. A must-have reference for technical professionals interested in better ways for preparing documents and presentations.

On Writing Well

On Writing Well
Author: William Knowlton Zinsser
Publisher: HarperCollins Publishers
Total Pages: 260
Release: 1985
Genre: English language
ISBN:

On Writing Well, which grew out of a course that William Zinsser taught at Yale, has been praised for its sound advice, its clarity, and for the warmth of its style. It is a book for anybody who wants to learn how to write or who needs to do some writing to get through the day, as almost everybody does. Whether you want to write about people or places, science and technology, business, sports, the arts, or about yourself in the increasingly popular memoir genre, On Writing Well offers you both fundamental principles as well as the insights of a distinguished practitioner. How to Write a Memoir tells you how to write the story of your life. Everyone has a story - whether you're a professional writer or just want to validate your personal and family reminiscences, William Zinsser explains how to do it, and do it well.

Developing Quality Technical Information

Developing Quality Technical Information
Author: Gretchen Hargis
Publisher: Pearson Education
Total Pages: 550
Release: 2004-04-06
Genre: Technology & Engineering
ISBN: 0137034784

"The examples are excellent--right on target and easy to understand and adapt. Even those who don't adopt the entire procedure can profit from the parts, but the greatest value will flow to those who adopt the whole." --Carolyn Mulford, senior writer and editor of Writing That Works "This is also a book that students can keep for their professional libraries because it will increase in its value to them after they leave class and face real life experiences on the job. It is plain enough for them to understand while they are learning, and at the same time comprehensive enough to support them as professionals." --Elizabeth Boling, Instructional Systems Technology, Indiana University "It practices what it preaches. Its guidelines are understandable and appropriate; its examples clear. It contains exactly what writers and editors need to know. It is the book that I would have written." --Cynthia E. Spellman, Unisys The #1 guide to excellence in documentation--now completely updated! A systematic, proven approach to creating great documentation Thoroughly revised and updated More practical examples More coverage of topic-based information, search, and internationalization Direct from IBM's own documentation experts, this is the definitive guide to developing outstanding technical documentation--for the Web and for print. Using extensive before-and-after examples, illustrations, and checklists, the authors show exactly how to create documentation that's easy to find, understand, and use. This edition includes extensive new coverage of topic-based information, simplifying search and retrievability, internationalization, visual effectiveness, and much more. Coverage includes: Focusing on the tasks and topics users care about most Saying more with fewer words Using organization and other means to deliver faster access to information Presenting information in more visually inviting ways Improving the effectiveness of your review process Learning from example: sample text, screen captures, illustrations, tables, and much more Whether you're a writer, editor, designer, or reviewer, if you want to create great documentation, this book shows you how!