Technical Documentation and Process

Technical Documentation and Process PDF

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 Product is Docs

The Product is Docs PDF

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.

The Art of Technical Documentation

The Art of Technical Documentation PDF

Author: Katherine Haramundanis

Publisher: Digital Press

Published: 2014-05-16

Total Pages: 287

ISBN-13: 1483184013

DOWNLOAD EBOOK →

The Art of Technical Documentation presents concepts, techniques, and practices in order to produce effective technical documentation. The book provides the definition of technical documentation; qualities of a good technical documentation; career paths and documentation management styles; precepts of technical documentation; practices for gathering information, understanding what you have gathered, and methods for testing documentation; and considerations of information representation, to provide insights on how different representations affect reader perception of your documents. Technical writers and scientists will find the book a good reference material.

Developing Quality Technical Information

Developing Quality Technical Information PDF

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 PDF

Author: Jerry C. Whitaker

Publisher: CRC Press

Published: 2018-09-03

Total Pages: 198

ISBN-13: 1351833030

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.

Modern Fortran

Modern Fortran PDF

Author: Milan Curcic

Publisher: Simon and Schuster

Published: 2020-10-07

Total Pages: 414

ISBN-13: 1638350051

DOWNLOAD EBOOK →

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

Docs Like Code

Docs Like Code PDF

Author: Anne Gentle

Publisher: Lulu.com

Published: 2018-01-13

Total Pages: 118

ISBN-13: 1387081322

DOWNLOAD EBOOK →

Looking for a way to invigorate your technical writing team and grow that expertise to include developers, designers, and writers of all backgrounds? When you treat docs like code, you multiply everyoneÕs efforts and streamline processes through collaboration, automation, and innovation. Second edition now available with updates and more information about version control for documents and continuous publishing.

Technical Writing One Hundred One

Technical Writing One Hundred One PDF

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.

Managing Your Documentation Projects

Managing Your Documentation Projects PDF

Author: JoAnn T. Hackos

Publisher: Wiley

Published: 1994

Total Pages: 654

ISBN-13: 9780471590996

DOWNLOAD EBOOK →

Practical, authoritative, and the first comprehensive guide tomanaging every phase of your publication project. The only bookdevoted exclusively to technical publication project management,Managing Your Documentation Projects arms you with provenstrategies and techniques for producing high-quality, extremelyusable documentation, while cutting cost and time-to-market. Dr.JoAnn T. Hackos, a top documentation design and project managementconsultant to major corporations, including IBM andHewlett-Packard, shares with you the fruit of her more than 15years of experience in the field. She gives you: * Clear-cut, rational guidelines to managing every phase of theproject from planning and development, through production,distribution, and project evaluation * Scores of usable templates, checklists, summaries, andforms * Dozens of real-life case studies and scenarios taken from theauthor's extensive experience at top corporations * Techniques applicable to virtually all fields ofdocumentation Managing Your Documentation Projects was designed to function as acomprehensive guide for new managers and a daily tool of survivalfor veterans. It is also an invaluable resource for technicalwriters, editors, graphic designers, consultants, and anyone calledupon to produce high-quality technical documentation on time andwithin budget. JOANN T. HACKOS, PhD, is President of ComtechServices, Inc., an information/design firm in Denver, Colorado andSan Jose, California. She is also president of JoAnn Hackos &Associates, Inc., a strategic planning and management consultingfirm. In 1993, she served as president of the Society for TechnicalCommunication (STC) and is a frequent conference keynote speaker onsuch topics as quality and usability of products and services, theimportance of meeting the needs of the customer, and projectmanagement.