Limit search to available items
Book Cover
E-book
Author Bhatti, Jared

Title Docs for Developers An Engineer's Field Guide to Technical Writing
Published Berkeley, CA : Apress L. P., 2021
Online access available from:
Safari O'Reilly books online    View Resource Record  

Copies

Description 1 online resource (241 p.)
Contents Intro -- Table of Contents -- About the Authors -- Acknowledgments -- Foreword -- Introduction -- Chapter 1: Understanding your audience -- Corg.ly: One month to launch -- The curse of knowledge -- Creating an initial sketch of your users -- Defining your users' goals -- Understanding who your users are -- Outline your users' needs -- Validate your user understanding -- Using existing data sources -- Support tickets -- Collecting new data -- Direct interviews -- Developer surveys -- Condensing user research findings -- User personas -- User stories -- User journey maps
Choosing your writing tools -- Breaking through the blank page -- Defining your document's title and goal -- Creating your outline -- Meeting your reader's expectations -- Completing your outline -- Creating your draft -- Headers -- Paragraphs -- Procedures -- Lists -- Callouts -- Writing for skimming -- State your most important information first -- Break up large blocks of text -- Break up long documents -- Strive for simplicity and clarity -- Getting unstuck -- Let go of perfectionism -- Ask for help -- Highlight missing content -- Write out of sequence -- Change your medium
Creating a friction log -- Summary -- Chapter 2: Planning your documentation -- Corg.ly: Creating a plan -- Plans and patterns -- Content types -- Code comments -- READMEs -- Getting started documentation -- Conceptual documentation -- Procedural documentation -- Tutorials -- How-to guides -- Reference documentation -- API reference -- Glossary -- Troubleshooting documentation -- Change documentation -- Planning your documentation -- Summary -- Chapter 3: Drafting documentation -- Corg.ly: First drafts -- Confronting the blank page (or screen) -- Setting yourself up for writing success
Using code samples -- Types of code samples -- Principles of good code samples -- Explained -- Concise -- Clear -- Usable (and extensible) -- Trustworthy -- Designing code samples -- Choosing a language -- Highlighting a range of complexity -- Presenting your code -- Tooling for code samples -- Testing code samples -- Sandboxing code -- Autogenerating samples -- Summary -- Chapter 6: Adding visual content -- Corg.ly: Worth a thousand words -- When words aren't enough -- Why visual content is hard to create -- Comprehension -- Accessibility -- Performance -- Using screenshots
Working from templates -- Finishing your first draft -- Summary -- Chapter 4: Editing documentation -- Corg.ly: Editing content -- Editing to meet your user's needs -- Different approaches to editing -- Editing for technical accuracy -- Editing for completeness -- Editing for structure -- Editing for clarity and brevity -- Creating an editing process -- Reviewing your document first -- Requesting a peer review -- Requesting a technical review -- Receiving and integrating feedback -- Giving good feedback -- Summary -- Chapter 5: Integrating code samples -- Corg.ly: Showing how it works
Notes Common types of diagrams
Description based upon print version of record
Genre/Form Electronic books.
Form Electronic book
Author Corleissen, Zachary Sarah
Lambourne, Jen
Nunez, David
Waterhouse, Heidi
ISBN 148427217X
9781484272176