Docs for Developers Book by David Nunez - Bookswagon
Home > Dictionaries & Language > Language: reference & general > Language: history & general works > Docs for Developers
Docs for Developers

Docs for Developers

|
     4  |  8 Reviews 
5
4
3
2
1




International Edition


About the Book

  1. Getting Started

  2. Researching documentation

    1. Understanding your users

    2. Cultivating empathy

    3. Understanding user desires, user needs, and company needs

    4. Recruiting users for research

  3. Research methods

    1. Reading code comments

    2. Trying it out

    3. Friction logs

    4. Running diverse and inclusive focus groups and interviews

    5. User journey mapping

  4. Identifying and working with stakeholders

    1. Finding your experts

    2. Collaborative documentation development

  5. Learning from existing content

    1. The value of design documents

    2. Finding examples in industry

  • Designing documentation

    1. Defining your initial set of content

    2. Deciding your minimum viable documentation

    3. Drafting test and acceptance criteria

  • Understanding content types

  • Concepts, tutorials and reference documentation

  • Code comments

  • API specifications

  • READMEs

  • Guides

  • Release notes

  • Drafting documentation

    1. Setting yourself up for writing success

    2. Who is this for? Personas, requirements, content types

    3. Definition of done

    4. How to iterate

    Tools and tips for writing rough drafts

    1. Understanding your needs

    2. Choosing your writing tools (handwriting, text-only, productivity/measurement writing tools)

    3. "Hacks" to get started drafting content

  • Mechanics

  • Headings

  • Paragraphs

  • Lists

  • Notes and warnings

  • Conclusions/tests

  • Using templates to form drafts

    1. Purpose of a template

    2. How to derive a template from existing docs

    3. How to take templates into text

  • Gathering initial feedback

  • Feedback methods

  • Integrating feedback

  • Getting feedback from difficult contributors

  • Editing content for publication

    1. Determine destination

    2. Editing tools (Grammarly, linters, etc)

    3. Declaring good enough

  • Recap, strategies, and reassurance

  • Structuring sets of documentation

    1. Where content types live

    2. Concepts, tutorials and reference documentation

    3. Code comments

    4. API specifications

    5. READMEs

    6. Guides

    7. Release notes

  • Designing your information architecture

    1. Content information architecture styles

    2. Designing for search

    3. Creating clear, well-lit paths through content

  • User testing and maintenance

  • Planning for document automation

  • Integrating code samples and visual content

    1. Integrating code samples

    2. When and why to use code samples

    3. Creating concise, usable, maintainable samples

    4. Standardising your samples

  • Using visual content: Screenshots, diagrams, and videos

    1. When your documentation may need visual content

    2. Making your visual content accessible

    3. Integrating screenshots, diagrams

    4. Videos

  • Measuring documentation success

  • How documentation succeeds

  • Measuring different types of documentation quality

    1. Structural Quality

    2. Functional Quality

    3. Process Quality

  • Measuring what you want to change

  • Drawing conclusio
    About the Author:

    Jared Bhatti


    Jared is a Staff Technical Writer at Alphabet, and the co-founder of Google's Cloud documentation team. He's worked for the past 14 years documenting an array of projects at Alphabet, including Kubernetes, App Engine, Adsense, Google's data centers, and Google's environmental sustainability efforts. He currently leads technical documentation at Waymo and mentors several junior writers in the industry.

    Zachary Sarah Corleissen

    Zach began this book as the Lead Technical Writer for the Linux Foundation and ended it as Stripe's first Staff Technical Writer. Zach served as co-chair for Kubernetes documentation from 2017 until 2021, and has worked on developer docs previously at GitHub, Rackspace, and several startups. They enjoy speaking at conferences and love to mentor writers and speakers of all abilities and backgrounds.

    Heidi Waterhouse

    Heidi spent a couple decades at Microsoft, Dell Software, and many, many startups learning to communicate with and for developers. She currently works as a principal developer advocate at LaunchDarkly, but was reassured to find that technical communication is universal across all roles.

    David Nunez

    David heads up the technical writing organization at Stripe, where he founded the internal documentation team and wrote for Increment magazine. Before Stripe, he founded and led the technical writing organization at Uber and held a documentation leadership role at Salesforce. Having led teams that have written about cloud, homegrown infrastructure, self-driving trucks, and economic infrastructure, he's studied the many ways that technical documentation can shape the user experience. David also acts as an advisor for several startups in the knowledge platform space.

    Jen Lambourne

    Jen leads the technical writing and knowledge management discipline at Monzo Bank. Before her foray into fintech, she led a community of documentarians across the UK government as Head of Technical Writing at the Government Digital Service (GDS). Having moved from government to finance, she recognizes she's drawn to creating inclusive and user-centred content in traditionally unfriendly industries. She likes using developer tools to manage docs, demystifying the writing process for engineers, mentoring junior writers, and presenting her adventures in documentation at conferences.



    Best Sellers



    Product Details
    • ISBN-13: 9781484272169
    • Publisher: Apress
    • Publisher Imprint: Apress
    • Height: 234 mm
    • No of Pages: 240
    • Spine Width: 13 mm
    • Weight: 408 gr
    • ISBN-10: 1484272161
    • Publisher Date: 26 Nov 2021
    • Binding: Paperback
    • Language: English
    • Returnable: Y
    • Sub Title: An Engineer's Field Guide to Technical Writing
    • Width: 156 mm


    Similar Products

    Add Photo
    Add Photo

    Customer Reviews

         4  |  8 Reviews 
    out of (%) reviewers recommend this product
    Top Reviews
    Rating Snapshot
    Select a row below to filter reviews.
    5
    4
    3
    2
    1
    Average Customer Ratings
         4  |  8 Reviews 
    00 of 0 Reviews
    Sort by :
    Active Filters

    00 of 0 Reviews
    SEARCH RESULTS
    1–2 of 2 Reviews
      BoxerLover2 - 5 Days ago
      A Thrilling But Totally Believable Murder Mystery

      Read this in one evening. I had planned to do other things with my day, but it was impossible to put down. Every time I tried, I was drawn back to it in less than 5 minutes. I sobbed my eyes out the entire last 100 pages. Highly recommend!

      BoxerLover2 - 5 Days ago
      A Thrilling But Totally Believable Murder Mystery

      Read this in one evening. I had planned to do other things with my day, but it was impossible to put down. Every time I tried, I was drawn back to it in less than 5 minutes. I sobbed my eyes out the entire last 100 pages. Highly recommend!


    Sample text
    Photo of
      Media Viewer

      Sample text
      Reviews
      Reader Type:
      BoxerLover2
      00 of 0 review

      Your review was submitted!
      Docs for Developers
      Apress -
      Docs for Developers
      Writing guidlines
      We want to publish your review, so please:
      • keep your review on the product. Review's that defame author's character will be rejected.
      • Keep your review focused on the product.
      • Avoid writing about customer service. contact us instead if you have issue requiring immediate attention.
      • Refrain from mentioning competitors or the specific price you paid for the product.
      • Do not include any personally identifiable information, such as full names.

      Docs for Developers

      Required fields are marked with *

      Review Title*
      Review
        Add Photo Add up to 6 photos
        Would you recommend this product to a friend?
        Tag this Book Read more
        Does your review contain spoilers?
        What type of reader best describes you?
        I agree to the terms & conditions
        You may receive emails regarding this submission. Any emails will include the ability to opt-out of future communications.

        CUSTOMER RATINGS AND REVIEWS AND QUESTIONS AND ANSWERS TERMS OF USE

        These Terms of Use govern your conduct associated with the Customer Ratings and Reviews and/or Questions and Answers service offered by Bookswagon (the "CRR Service").


        By submitting any content to Bookswagon, you guarantee that:
        • You are the sole author and owner of the intellectual property rights in the content;
        • All "moral rights" that you may have in such content have been voluntarily waived by you;
        • All content that you post is accurate;
        • You are at least 13 years old;
        • Use of the content you supply does not violate these Terms of Use and will not cause injury to any person or entity.
        You further agree that you may not submit any content:
        • That is known by you to be false, inaccurate or misleading;
        • That infringes any third party's copyright, patent, trademark, trade secret or other proprietary rights or rights of publicity or privacy;
        • That violates any law, statute, ordinance or regulation (including, but not limited to, those governing, consumer protection, unfair competition, anti-discrimination or false advertising);
        • That is, or may reasonably be considered to be, defamatory, libelous, hateful, racially or religiously biased or offensive, unlawfully threatening or unlawfully harassing to any individual, partnership or corporation;
        • For which you were compensated or granted any consideration by any unapproved third party;
        • That includes any information that references other websites, addresses, email addresses, contact information or phone numbers;
        • That contains any computer viruses, worms or other potentially damaging computer programs or files.
        You agree to indemnify and hold Bookswagon (and its officers, directors, agents, subsidiaries, joint ventures, employees and third-party service providers, including but not limited to Bazaarvoice, Inc.), harmless from all claims, demands, and damages (actual and consequential) of every kind and nature, known and unknown including reasonable attorneys' fees, arising out of a breach of your representations and warranties set forth above, or your violation of any law or the rights of a third party.


        For any content that you submit, you grant Bookswagon a perpetual, irrevocable, royalty-free, transferable right and license to use, copy, modify, delete in its entirety, adapt, publish, translate, create derivative works from and/or sell, transfer, and/or distribute such content and/or incorporate such content into any form, medium or technology throughout the world without compensation to you. Additionally,  Bookswagon may transfer or share any personal information that you submit with its third-party service providers, including but not limited to Bazaarvoice, Inc. in accordance with  Privacy Policy


        All content that you submit may be used at Bookswagon's sole discretion. Bookswagon reserves the right to change, condense, withhold publication, remove or delete any content on Bookswagon's website that Bookswagon deems, in its sole discretion, to violate the content guidelines or any other provision of these Terms of Use.  Bookswagon does not guarantee that you will have any recourse through Bookswagon to edit or delete any content you have submitted. Ratings and written comments are generally posted within two to four business days. However, Bookswagon reserves the right to remove or to refuse to post any submission to the extent authorized by law. You acknowledge that you, not Bookswagon, are responsible for the contents of your submission. None of the content that you submit shall be subject to any obligation of confidence on the part of Bookswagon, its agents, subsidiaries, affiliates, partners or third party service providers (including but not limited to Bazaarvoice, Inc.)and their respective directors, officers and employees.

        Accept

        New Arrivals



        Inspired by your browsing history


        Your review has been submitted!

        You've already reviewed this product!