Nzubechukwu.
← All posts
Open source4 min read

Documenting a project you don't fully understand

The best person to document a concept is the person who just struggled with it. Your confusion is the map.

By Nzubechukwu Cyprian · Pharmacy student at UNN, full-stack developer

Cover image for “Documenting a project you don't fully understand” — Open source

Counterintuitive but true: the moment you finally understand something is when you're qualified to document it — and more qualified than the experts, because the confusion is fresh in your memory.

Why the newcomer's view wins

Experts document from the summit. "Simply configure the middleware" — with three unstated prerequisites and an assumption you know what middleware is. The person who struggled yesterday remembers exactly which steps were opaque, which terms were undefined, and where they almost quit. That memory is the documentation.

The method I use

  1. While stuck, write down every question I had to answer elsewhere — those are the doc's missing sections
  2. When it finally works, write the guide I wish had existed, immediately, while the pain is vivid
  3. Submit it as a PR to the project's docs — with a note that it's written from a newcomer's path, so maintainers know the angle

Why maintainers accept these

Docs written from the novice's path fill gaps experts can't see. The contributor is essentially providing free usability testing with the results written up. Every project needs this and almost none get it.

Your confusion isn't impostor syndrome. It's raw material.

Found this useful? Send it to someone.

Nzubechukwu Cyprian studies Pharmacy at the University of Nigeria, Nsukka and builds software, products, and AI experiments in between.

One email when a post lands

No schedule, no spam. Just the posts worth reading — new writing on software, AI, products, and the Pharmacy × Tech life.

Prefer a feed reader? Grab the RSS feed.