Skip to content
PodSubs
ShowsPeopleGuestsJobsNewsEvents
More
BlogPodCred
Menu
ShowsPeopleGuestsJobsNewsEventsBlogPodCredNetworksSign in
Join nowSign in
  • Shows
  • People
  • Jobs
  • News
  • More
    • Guests
    • Events
    • Blog
    • PodCred
    • Networks
    Join nowSign in

Sustain

Sustain artwork

Episode 8: Writing Good Documentation with Chris Ward

Sep 13, 201953 minAudio
ShareXLinkedInFacebookWhatsAppEmail

Sponsors Gitlab Commit Adventures in DevOps Podcast The DevEd Podcast Cachefly Panel Richard Littauer Joined By Special Guest: Chris Ward Episode Summary This week, Sustain Our Software welcomes Chris Ward, Technical Writer at Ethereum from Berlin, Germany. Chris shares his story of how he became a technical writer as well tips and resources for good documentation writing. After many years working as a developer, Chris realized he enjoyed helping others understand technical subjects. Chris defines a path of how to become a technical writer. He advises contributing to Open Source projects as well as joining the Write the Docs Society. Chris and Richard discuss why having good documentation is important and what the minimum viable documentation for a project is. Often times the assumptions that developers make are not very obvious to other developers on the project and the users. Then then discuss the common challenges a technical writer faces when creating documentation targeting developers, contributors and Getting Started Guide. A good technical documentation develops over time and like code it's never really done and newer versions are rolled out as questions come in. Chris recommends some tools for technical writing as well as a book by Stephen King called On Writing. He also recommends dogfooding or hackathons to help the developers work on usability issues. Then they talk about how the Bounties model can also be applied to documentation writing. Links Learn to Build on Ethereum with Kauri https://readthedocs.org/ https://github.com/btford/write-good/ Society for Technical Communication https://www.ethereum.org/ Write the Docs Society https://gitcoin.co/ On Writing https://github.com/errata-ai/vale https://chrischinchilla.com/ Picks Chris Ward: On Writing by Stephen King Write the Docs Society https://git-fork.com/ Richard Littauer: Bird by Bird by Anne Lamott Web3 Summit 2019 https://stevenpressfield.com/books/the-war-of-art/ Special Guest: Chris Ward.

Audio and video play straight from the show's own hosting. PodSubs stores and serves no media.

Hosts and Guests

Hosts

  • Richard Littauer Host Feed-stated

Guests

  • Chris Ward Guest Feed-stated

Credit the people on this episode

Be the first to rate this episode

More episodes

All episodes
  1. Episode 297: Ashwathi Iyer and Megan Forbes on Academic OSPOs and TTOs

    Nov 13, 202631 minAudio

    Guests Megan Forbes | Ashwathi Iyer Panelist Richard Littauer Show Notes What happens to open source projects when the research funding runs out? Universities are responsible for creating groundbreaking software but...

    Credit the people on this episode

  2. Episode 296: Jingna Zhang on Protecting Artists from AI

    Oct 30, 202635 minAudio

    Guest Jingna Zhang Panelists Richard Littauer | Eriol Fox Show Notes In this episode of Sustain, Richard and Eriol talk with Jingna Zhang about Cara, AI copyright, and protecting artists’ creative ownership. The...

    Credit the people on this episode

  3. Episode 295: Jiayi Sun & Shurui Zhou on Codes of Conduct in Open Source Communities

    Oct 16, 202634 minAudio

    Guest Jiayi Sun | Shurui Zhou Panelist Richard Littauer Show Notes In this episode of Sustain, Richard Littauer is joined by University of Toronto researchers Jiayi Sun and Shurui Zhou to discuss their research on how...

    Credit the people on this episode

  4. Episode 294: Carol Willing & Hugo Bowne-Anderson on AI and OSS

    Oct 2, 202645 minAudio

    Guest Carol Willing | Hugo Bowne-Anderson Panelist Richard Littauer Show Notes Richard is joined by guests Carol Willing and Hugo Bowne-Anderson for a conversation about AI, open source, and what happens to communities...

    Credit the people on this episode

  5. Episode 293: Daniel Roe and Matias Capeletto of npmx

    Aug 21, 202638 minAudio

    Guest Daniel Roe | Matias Capeletto Panelist Richard Littauer Show Notes In this episode of Sustain, Richard Littauer sits down with Daniel Roe and Matias “Patak” Capeletto to talk about npmx, the community-built...

    Credit the people on this episode