Why is documentation important and how can we make it better?

11/10/23 • 29 min

In this episode, we talk to Mike Jang (Lead Technical Writer at Forescout Technologies) about his philosophy on what makes a good documentation and how having an open source documentation makes it easier to get feedback from the end user community.

TiDB Docs Dash blog post: https://www.pingcap.com/blog/why-documentation-is-important/
Event page: https://www.pingcap.com/event/tidb-docs-dash/

You can also listen on your favorite podcast platforms such as Apple Podcast, Spotify, etc. For a full list of podcast platforms, you can check out https://datainthehallway.buzzsprout.com/.
If you have any feedback or suggestions for episodes, you can email us at [email protected].

————————— About PingCAP and TiDB —————————
PingCAP is the creator of #TiDB, an advanced, #OpenSource, #DistributedSQL database with #MySQL compatibility. TiDB powers modern applications with a streamlined tech stack, elastic scaling, real-time analytics, and continuous access to data—all in a single database.
————————— Developer resources —————————
💫TiDB Twitter: https://twitter.com/TiDB_Developer
💫Introducing TiDB: https://youtu.be/_QBrPBwFoWM
💫Quick start with TiDB: https://docs.pingcap.com/tidb/stable/quick-start-with-tidb
💫TiDB in #Kubernetes: https://docs.pingcap.com/tidb-in-kubernetes/stable
————————— Connect with PingCAP —————————
🔹Twitter: https://twitter.com/PingCAP
🔹LinkedIn: https://linkedin.com/company/pingcap
🔹Facebook: https://facebook.com/pingcap2015
🔹Slack: https://slack.tidb.io/invite?team=tidb-community&channel=everyone&ref=pingcap
🔹GitHub: https://github.com/pingcap

TiDB Docs Dash blog post: https://www.pingcap.com/blog/why-documentation-is-important/
Event page: https://www.pingcap.com/event/tidb-docs-dash/

Previous Episode

Book club discussion: High Performance Data Architectures report

In this episode, we talk to Brian Foster (Director of Content Marketing at PingCAP) about the O’Reilly Report titled High-Performance Data Architectures. We discuss what was involved in creating a report, what our community members can learn from the content, and future plans.
High-Performance Data Architectures (O’Reilly Report): https://www.pingcap.com/ebook-whitepaper/oreilly-high-performance-data-architecture-report/
You can also listen on your favorite podcast platforms such as Apple Podcast, Spotify, etc. For a full list of podcast platforms, you can check out https://datainthehallway.buzzsprout.com/.
If you have any feedback or suggestions for episodes, you can email us at [email protected].

Next Episode

Helping developers with cloud cost optimization

In this episode, we talk to Stephen J. Barr (Principal Architect & Technical Evangelist at CloudFix) about how developers can get a better understanding of their cloud costs and optimize their AWS cloud infrastructure investments.
AWS Made Easy Livestream: https://www.youtube.com/@awsmadeeasy
CloudFix blogs: https://cloudfix.com/blog/
You can also listen on your favorite podcast platforms such as Apple Podcast, Spotify, etc. For a full list of podcast platforms, you can check out https://datainthehallway.buzzsprout.com/.
If you have any feedback or suggestions for episodes, you can email us at [email protected].