Episode 8: Writing Good Documentation with Chris Ward

from Sustain · host SustainOSS

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.

What this episode covers

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.Support Sustain

NOW PLAYING

Episode 8: Writing Good Documentation with Chris Ward

0:00 53:10

1×

No transcript for this episode yet

We transcribe on demand. Request one and we'll notify you when it's ready — usually under 10 minutes.

Share this episode

Similar Episodes

FINAL FIVE: Michael Kostroff, Actor in Dog Day Afternoon

Jun 19, 2026 ·12m

[Webinar] Beyond the Voice of the Customer: Richer Signals for Continuous Improvement

Jun 18, 2026 ·54m

[Preview] Beyond Voice of Customer: Reading the Signals Customers Send Without Saying a Word

Jun 15, 2026 ·6m

The Courage to Leave: Breaking Free From Toxic Workplaces With Jeff Davis

Jun 15, 2026 ·33m

Michael Kostroff Sees Performing as a Calling and Everyday He Answers That Call

Jun 12, 2026 ·52m

FINAL FIVE: Katerina Papacostas, Chess on Broadway

May 29, 2026 ·31m

Similar Podcasts

Chewing the Fat with WorkForge WorkForge Bite-Sized Conversations for Building a Stronger Workforce Welcome to Chewing the Fat, a podcast delving deep into the world of food manufacturing. Dive into real conversations around critical topics like staffing, retention, onboarding, and career development in this essential industry. Subscribe now to gain insights from your peers, subject matter experts and more on the biggest issues facing food manufacturers today: -Hiring and retaining employees -Addressing the challenges of the Silver Tsunami -Improving time to productivity of new employees -Engaging employees from hire to retire And more... Tune in to Chewing the Fat, a WorkForge podcast, and join the conversation on how to build and sustain a resilient, high-performing workforce in food manufacturing. The Habit Mechanic — Train Your Brain for the AI Revolution Dr. Jon Finn The Habit Mechanic is a science-based podcast about brain performance in the AI era.As AI reshapes the work humans get paid to do, focus, decision-making, and mental energy are becoming the real constraints on performance. This podcast explores how to optimise your brain’s natural energy patterns — what I call Brain States — so you can do high-value work, work effectively with AI, and sustain performance over time.I’m Dr Jon Finn, a performance consultant with 25 years’ experience working with professionals, leaders, teams, and elite performers across business and sport. Drawing on applied neuroscience, behavioural science, and real-world practice, each episode offers clear thinking and practical tools you can use immediately.If you’re interested in improving cognitive performance, avoiding burnout, and building the habits required to thrive alongside AI — without chasing tools or trends — this podcast is for you. Why I‘ll Never Make It Patrick Oliver Jones The actor’s journey is one of occasional highs and frequent lows. It is a path riddled with self-doubt and frustration as we question our career choices, wondering if we’ll ever really ”make it.” But it is those few moments of glory on stage or screen that can sustain us through all the setbacks and challenges. On this award-winning podcast, New York actor Patrick Oliver Jones invites fellow creatives to share three stories that offer a behind-the-scenes look at the creative life rarely seen in the glitz and glam of this industry. These conversations remind us we’re not alone in this often bumpy and winding journey of the performing arts. Surviving Your Journey Towards Success Podcast Nichel Anderson You will have access to my popular motivational quotes, discussions on topics that aims to assist you on your life journey. Guest interviews will also be featured to provide some perspective that enriches the discussion to further help others on their path to success or to sustain success.

Frequently Asked Questions

How long is this episode of Sustain?

This episode is 53 minutes long.

When was this Sustain episode published?

This episode was published on September 13, 2019.

What is this episode about?

Can I download this Sustain episode?

Yes, you can download this episode by clicking the download button on the episode player, or subscribe to the podcast in your preferred podcast app for automatic downloads.

URL copied to clipboard!