For my library and CLI projects, I've been writing documentation before writing any code. It helps me imagine the final interface early on, which usually leads to better design. Sure, sometimes I miss implementation details and have to revise later, but hey—it's just docs. Docs are easy to change.

This tiny habit has surprisingly big payoffs. When I focus on how things will be used rather than how they'll be built, I end up with interfaces that actually make sense.

Anyone else do this? Curious about your experience with documentation-first approaches.



RE: https://hollo.social/@hongminhee/01964c76-ef1e-7994-b3f0-57f967742566

8

If you have a fediverse account, you can reply to this note from your own instance. Search https://hackers.pub/ap/notes/01964c7d-1295-70f7-b7ea-c74e47436f27 on your instance and reply to it.

@hongminhee洪 民憙 (Hong Minhee) I half-joked about this some time ago, “docs driven development”. 😄 Happy to see it is working in reality for someone!

I think @sarah11918Sarah Rainsberger might know if others do it too 🤔

1

@hongminhee洪 民憙 (Hong Minhee) Document Driven Development!

2

@hongminhee洪 民憙 (Hong Minhee) back in the day, we used to call this a "specification"

0

@hongminhee洪 民憙 (Hong Minhee) I never start writing code before I gather enough context for the problem. Listening to possible customer's voices and collecting prior arts are one of the most important part of designing solutions.

2