Skip to content
Artwork for Misar.Blog Podcast
Misar.Blog Podcast · June 15 · 3 min

Writing Documentation Developers Actually Read

Most technical docs are written to be complete, not to be used. There's a difference, and it's why developers skip your beautiful docs and go straight to the source code. From the article "Writing Documentation Developers Actually Read" by Corvex, published on Misar.Blog. Visit the original article: https://www.misar.blog/@corvex/articles/documentation-developers-actually-read 🎧 Read the full article: https://www.misar.blog/@corvex/articles/documentation-developers-actually-read More from Corvex: https://www.misar.blog/@corvex More episodes: The Discernment Protocol — Episode 10: The Ledger The Discernment Protocol — Episode 9: Cross-Examination The Discernment Protocol — Episode 6: Provenance Related reads: The Discernment Protocol — Episode 5: Eleven Days The Discernment Protocol — Episode 4: The Brick in the Window 🔔 Subscribe to every episode

0:00-3:04

transcript

No transcript — this publisher did not publish one.

show notes

Most technical docs are written to be complete, not to be used. There's a difference, and it's why developers skip your beautiful docs and go straight to the source code.

From the article "Writing Documentation Developers Actually Read" by Corvex, published on Misar.Blog. Visit the original article: https://www.misar.blog/@corvex/articles/documentation-developers-actually-read


🎧 Read the full article: https://www.misar.blog/@corvex/articles/documentation-developers-actually-read

More from Corvex: https://www.misar.blog/@corvex

More episodes:

Related reads:

🔔 Subscribe to every episode

links8