Thoughts on Stack Overflow’s Documentation beta

  • Docs are often an afterthought
  • Docs are often written from an internal perspective, so they don’t give developers what they need
  • Docs aren’t heavy enough on the examples that help developers get started

Docs are often an afterthought

Docs are often written from an internal perspective, so they don’t give developers what they need

Users have knowledge that could fill the gaps in existing docs

Examples help developers get started

Things that are hard in the world of tech writing

The other end of the long tail

“I can’t find it!”

Maintainability

Conclusions

Appendix

--

--

--

Technical and UX writer

Love podcasts or audiobooks? Learn on the go with our new app.

Recommended from Medium

ERP & Business Process Mapping

Is your Linksys Range Extender broadcasting SSID name?

How long Does It Take To Learn C++ Programming

OEC Ecosystem Report — February 2022

Tips for Rails Developers to ramp up the Development.

How to Communicate between Node.js and Python

SOAP vs REST API — Everything You Need to Know

One-Pager: Tips for Intership Programs during COVID-

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store
Beth Aitman

Beth Aitman

Technical and UX writer

More from Medium

Authenticated Connectors In Microsoft Teams

Database Design

Make your automated UI tests more stable: Use Unique IDs!