2min chapter

Oxide and Friends cover image

The Frontend of the Computer

Oxide and Friends

CHAPTER

The Importance of Documentation in the Code

We do all of our documentation in line in the code. It's like in Markdown or ASCII doc, but I'm writing some Rust code. So we just take the Rust docs and we make that the documentation. And it's bitten us in some ways. Sometimes you can sort of forget that you're writing user facing documentation by yammering about internal implementation details rather than explaining what the API is.

00:00

Get the Snipd
podcast app

Unlock the knowledge in podcasts with the podcast player of the future.
App store bannerPlay store banner

AI-powered
podcast player

Listen to all your favourite podcasts with AI-powered features

Discover
highlights

Listen to the best highlights from the podcasts you love and dive into the full episode

Save any
moment

Hear something you like? Tap your headphones to save it with AI-generated key takeaways

Share
& Export

Send highlights to Twitter, WhatsApp or export them to Notion, Readwise & more

AI-powered
podcast player

Listen to all your favourite podcasts with AI-powered features

Discover
highlights

Listen to the best highlights from the podcasts you love and dive into the full episode