Best Practices For Technical Writers And Editors

Author : Francis DeRespinis,Peter Hayward,Jana Jenkins,Amy Laird,Leslie McDonald,Eric Radzinski,Laura Bellamy,Michelle Carey,Jenifer Schlotfeldt,Gretchen Hargis,Ann Kilty Hernandez,Polly Hughes,Deirdre Longo,Shannon Rouiller,Elizabeth Wilde
Publisher : Pearson Education
Page : 1508 pages
File Size : 48,8 Mb
Release : 2012-04-13
Category : Technology & Engineering
ISBN : 9780132929660

Get Book

Best Practices for Technical Writers and Editors, Video Enhanced Edition (Collection) by Francis DeRespinis,Peter Hayward,Jana Jenkins,Amy Laird,Leslie McDonald,Eric Radzinski,Laura Bellamy,Michelle Carey,Jenifer Schlotfeldt,Gretchen Hargis,Ann Kilty Hernandez,Polly Hughes,Deirdre Longo,Shannon Rouiller,Elizabeth Wilde Pdf

Normal 0 false false false MicrosoftInternetExplorer4 A brand new collection of state-of-the-art insights for technical writers, editors, and content managers…in a convenient e-format, at a great price! Three outstanding IBM Press eBooks plus exclusive video walkthroughs help you maximize the value and effectiveness of your technical communications—in all media, for all audiences, everywhere! (Enhanced eBook) This package brings together unsurpassed IBM eBook and video resources for creating clearer, more usable, more effective technical communication. For one low price, you get three outstanding IBM Press books in industry-standard ePub format, plus exclusive video demonstrations walking through many key topics and techniques on DITA, step-by-step! The IBM Style Guide: Conventions for Writers and Editors distills IBM’s best wisdom for developing higher-quality content across all media, authors, and geographic locations. It delivers up-to-the minute guidance on topic-based writing; writing for diverse media and global audiences; organizing, structuring, and linking information; maximizing accessibility; documenting interfaces and procedures; and much more. Next, in DITA Best Practices: A Roadmap for Writing, Editing, and Architecting in DITA , three pioneering implementers show how to use DITA to maximize the value of technical documentation, and offer a complete roadmap for successful DITA adoption and usage. The authors answer crucial questions “official” DITA documents ignore, including: “Where do you start?” and “How do you avoid the pitfalls?” Discover proven best practices for developing effective topics, short descriptions, and content architecture, plus “in-the-trenches” solutions for ensuring quality implementations and accurate, cost-effective content conversion, including video demonstrations. Finally, Developing Quality Technical Information: A Handbook for Writers and Editors , Second Edition, presents today’s most systematic, well-proven approach to creating great documentation. Learn how to focus on the right tasks and topics; say more with fewer words; use organization to deliver faster access; streamline and improve reviews; and much more. Packed with before-and-after examples, illustrations, and checklists, this book addresses crucial topics ranging from internationalization to retrievability to visual effectiveness. Whether you’re a writer, editor, reviewer, or manager, if you want to create outstanding content, you’ll find this collection absolutely indispensable. From expert IBM and IBM Press publication professionals Francis DeRespinis, Peter Hayward, Jana Jenkins, Amy Laird, Leslie McDonald, Eric Radzinski, Laura Bellamy, Michelle Carey, Jenifer Schlotfeldt, Gretchen Hargis, Ann Kilty Hernandez, Polly Hughes, Deirdre Longo, Shannon Rouiller, and Elizabeth Wilde. Important note: Due to the incredibly rich media included in your enhanced eBook, you may experience longer than usual download times. Please be patient while your product is delivered.

Author : Elizabeth Wilde,Ann Kilty Hernandez,Amy Laird,Shannon Rouiller,Francis DeRespinis,Deirdre Longo,Jenifer Schlotfeldt,Peter Hayward,Gretchen Hargis,Jana Jenkins,Michelle Carey,Eric Radzinski,Polly Hughes,Laura Bellamy,Leslie McDonald
Publisher : Unknown
Page : 1188 pages
File Size : 44,5 Mb
Release : 2012
Category : Electronic data processing documentation
ISBN : 0132929678

Get Book

Best Practices for Technical Writers and Editors by Elizabeth Wilde,Ann Kilty Hernandez,Amy Laird,Shannon Rouiller,Francis DeRespinis,Deirdre Longo,Jenifer Schlotfeldt,Peter Hayward,Gretchen Hargis,Jana Jenkins,Michelle Carey,Eric Radzinski,Polly Hughes,Laura Bellamy,Leslie McDonald Pdf

Author : William Zinsser
Publisher : HarperCollins Publishers
Page : 318 pages
File Size : 50,6 Mb
Release : 1988
Category : English language
ISBN : UCSC:32106013785297

Get Book

On Writing Well by William Zinsser Pdf

The revised and enlarged third edition of Zinsser's trusted writing guide covers the principles of good writing while including information on technical, business and sports writing, humor, interviews, working with a word processor, sexism, and a writer's attitudes toward language and craft.

Author : Susan Bilheimer
Publisher : Booklocker.com
Page : 0 pages
File Size : 44,7 Mb
Release : 2001-09
Category : Communication of technical information
ISBN : 0970196415

Get Book

How to Become a Technical Writer by Susan Bilheimer Pdf

If you can write clear, concise instructions, then you can be a technical writer. Learn, step-by-step, how to turn your creative writing talent into a highly lucrative career, where you get paid big money consistently to use your writing skills.

Author : Krista Van Laan
Publisher : XML Press
Page : 512 pages
File Size : 55,6 Mb
Release : 2012-05-15
Category : Reference
ISBN : 9781457182426

Get Book

The Insider's Guide to Technical Writing by Krista Van Laan Pdf

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

Author : Alan S. Pringle,Sarah S. O'Keefe
Publisher : Scriptorium Publishing
Page : 328 pages
File Size : 44,9 Mb
Release : 2009-05
Category : Technology & Engineering
ISBN : 9780970473370

Get Book

Technical Writing 101: A Real-World Guide to Planning and Writing Technical Content (Third Edition) by Alan S. Pringle,Sarah S. O'Keefe Pdf

Author : Alan S. Pringle,Sarah O'Keefe
Publisher : Scriptorium Publishing
Page : 292 pages
File Size : 49,9 Mb
Release : 2003
Category : Technology & Engineering
ISBN : 097047332X

Get Book

Technical Writing 101 by Alan S. Pringle,Sarah O'Keefe Pdf

Author : Kieran Morgan,Alison Pickering,Amanda Butler,Caity Cronkhite,Felicity Brand,John New,Steve Moss,Swapnil Ogale
Publisher : Boffin Education
Page : 494 pages
File Size : 53,6 Mb
Release : 2024-02-29
Category : Computers
ISBN : 9780994169334

Get Book

Technical Writing Process by Kieran Morgan,Alison Pickering,Amanda Butler,Caity Cronkhite,Felicity Brand,John New,Steve Moss,Swapnil Ogale Pdf

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

Author : Gretchen Hargis,Michelle Carey,Ann Kilty Hernandez,Polly Hughes,Deirdre Longo,Shannon Rouiller,Elizabeth Wilde
Publisher : Pearson Education
Page : 550 pages
File Size : 50,7 Mb
Release : 2004-04-06
Category : Technology & Engineering
ISBN : 9780137034789

Get Book

Developing Quality Technical Information by Gretchen Hargis,Michelle Carey,Ann Kilty Hernandez,Polly Hughes,Deirdre Longo,Shannon Rouiller,Elizabeth Wilde Pdf

"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!

Author : Laura Bellamy,Michelle Carey,Jenifer Schlotfeldt
Publisher : IBM Press
Page : 266 pages
File Size : 46,6 Mb
Release : 2012
Category : Computers
ISBN : 9780132480529

Get Book

DITA Best Practices by Laura Bellamy,Michelle Carey,Jenifer Schlotfeldt Pdf

&>The Start-to-Finish, Best-Practice Guide to Implementing and Using DITA Darwin Information Typing Architecture (DITA) is today's most powerful toolbox for constructing information. By implementing DITA, organizations can gain more value from their technical documentation than ever before. Now, three DITA pioneers offer the first complete roadmap for successful DITA adoption, implementation, and usage. Drawing on years of experience helping large organizations adopt DITA, the authors answer crucial questions the "official" DITA documents ignore, including: Where do you start? What should you know up front? What are the pitfalls in implementing DITA? How can you avoid those pitfalls? The authors begin with topic-based writing, presenting proven best practices for developing effective topics and short descriptions. Next, they address content architecture, including how best to set up and implement DITA maps, linking strategies, metadata, conditional processing, and content reuse. Finally, they offer "in the trenches" solutions for ensuring quality implementations, including guidance on content conversion. Coverage includes: Knowing how and when to use each DITA element-and when not to Writing "minimalist," task-oriented information that quickly meets users' needs Creating effective task, concept, and reference topics for any product, technology, or service Writing effective short descriptions that work well in all contexts Structuring DITA maps to bind topics together and provide superior navigation Using links to create information webs that improve retrievability and navigation Gaining benefits from metadata without getting lost in complexity Using conditional processing to eliminate redundancy and rework Systematically promoting reuse to improve quality and reduce costs Planning, resourcing, and executing effective content conversion Improving quality by editing DITA content and XML markup If you're a writer, editor, information architect, manager, or consultant who evaluates, deploys, or uses DITA, this book will guide you all the way to success. Also see the other books in this IBM Press series: Developing Quality Technical Information: A Handbook for Writers and Editors The IBM Style Guide: Conventions for Writers and Editors

Author : Alan S. Pringle,Sarah S. O'Keefe
Publisher : Lulu.com
Page : 330 pages
File Size : 45,7 Mb
Release : 2009
Category : Computers
ISBN : 9780970473363

Get Book

Technical Writing One Hundred One by Alan S. Pringle,Sarah S. O'Keefe Pdf

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.

Author : Kieran Morgan
Publisher : Technical Writing Process
Page : 0 pages
File Size : 43,5 Mb
Release : 2015
Category : Communication of technical information
ISBN : 0994169310

Get Book

Technical Writing Process by Kieran Morgan Pdf

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

Author : Microsoft Corporation
Publisher : Pearson Education
Page : 969 pages
File Size : 53,7 Mb
Release : 2012-01-15
Category : Computers
ISBN : 9780735669796

Get Book

Microsoft Manual of Style by Microsoft Corporation Pdf

Maximize the impact and precision of your message! Now in its fourth edition, the Microsoft Manual of Style provides essential guidance to content creators, journalists, technical writers, editors, and everyone else who writes about computer technology. Direct from the Editorial Style Board at Microsoft—you get a comprehensive glossary of both general technology terms and those specific to Microsoft; clear, concise usage and style guidelines with helpful examples and alternatives; guidance on grammar, tone, and voice; and best practices for writing content for the web, optimizing for accessibility, and communicating to a worldwide audience. Fully updated and optimized for ease of use, the Microsoft Manual of Style is designed to help you communicate clearly, consistently, and accurately about technical topics—across a range of audiences and media.

Author : Larry S. Lopez
Publisher : Unknown
Page : 130 pages
File Size : 50,5 Mb
Release : 1979
Category : Technical writing
ISBN : UOM:39015086529149

Get Book

Style Guide (mechanical) for Technical Writers by Larry S. Lopez Pdf

Author : Milan Curcic
Publisher : Simon and Schuster
Page : 414 pages
File Size : 51,8 Mb
Release : 2020-10-07
Category : Computers
ISBN : 9781638350057

Get Book

Modern Fortran by Milan Curcic Pdf

Modern Fortran teaches you to develop fast, efficient parallel applications using twenty-first-century Fortran. In this guide, you’ll dive into Fortran by creating fun apps, including a tsunami simulator and a stock price analyzer. Filled with real-world use cases, insightful illustrations, and hands-on exercises, Modern Fortran helps you see this classic language in a whole new light. Summary Using Fortran, early and accurate forecasts for hurricanes and other major storms have saved thousands of lives. Better designs for ships, planes, and automobiles have made travel safer, more efficient, and less expensive than ever before. Using Fortran, low-level machine learning and deep learning libraries provide incredibly easy, fast, and insightful analysis of massive data. Fortran is an amazingly powerful and flexible programming language that forms the foundation of high performance computing for research, science, and industry. And it's come a long, long way since starting life on IBM mainframes in 1956. Modern Fortran is natively parallel, so it's uniquely suited for efficiently handling problems like complex simulations, long-range predictions, and ultra-precise designs. If you're working on tasks where speed, accuracy, and efficiency matter, it's time to discover—or re-discover—Fortran.. About the technology For over 60 years Fortran has been powering mission-critical scientific applications, and it isn't slowing down yet! Rock-solid reliability and new support for parallel programming make Fortran an essential language for next-generation high-performance computing. Simply put, the future is in parallel, and Fortran is already there. Purchase of the print book includes a free eBook in PDF, Kindle, and ePub formats from Manning Publications. About the book Modern Fortran teaches you to develop fast, efficient parallel applications using twenty-first-century Fortran. In this guide, you'll dive into Fortran by creating fun apps, including a tsunami simulator and a stock price analyzer. Filled with real-world use cases, insightful illustrations, and hands-on exercises, Modern Fortran helps you see this classic language in a whole new light. What's inside Fortran's place in the modern world Working with variables, arrays, and functions Module development Parallelism with coarrays, teams, and events Interoperating Fortran with C About the reader For developers and computational scientists. No experience with Fortran required. About the author Milan Curcic is a meteorologist, oceanographer, and author of several general-purpose Fortran libraries and applications. Table of Contents PART 1 - GETTING STARTED WITH MODERN FORTRAN 1 Introducing Fortran 2 Getting started: Minimal working app PART 2 - CORE ELEMENTS OF FORTRAN 3 Writing reusable code with functions and subroutines 4 Organizing your Fortran code using modules 5 Analyzing time series data with arrays 6 Reading, writing, and formatting your data PART 3 - ADVANCED FORTRAN USE 7 Going parallel with Fortan coarrays 8 Working with abstract data using derived types 9 Generic procedures and operators for any data type 10 User-defined operators for derived types PART 4 - THE FINAL STRETCH 11 Interoperability with C: Exposing your app to the web 12 Advanced parallelism with teams, events, and collectives