Documentation is the UI for many technical products. You can build, build, build, but if your docs are an afterthought, people won’t see the features clearly. It’s also helpful for AI to pick up in explanations.
Comments
Log in with your Bluesky account to leave a comment
I find solid documentation to be even more important in the age of LLM-backed programming tools.
I’ve adopted a “spec-based” approach where I detail what needs to be built and with which dependencies across multiple connected spec files and then point an LLM at the first spec file and let it run.
Agreed, only wished all companies/managers/leads embraced it. Faced with deadlines and the need to bring (short-term usually) value to business, devs are forced to move past this important bit
Absolutely correct -- documentation is every bit as much of the "product" as the software itself is, and if you have shitty docs...your users will think you've got a shitty product.
Comments
"why write docs, your code should be self-documenting" trope just isn't grounded in reality.
It’s one of my go-to tools for complex logic because it works on both the frontend and backend.
You can check them out at https://stately.ai
Also check out @davidkpiano.bsky.social YouTube. Lots of great talks explaining state machines.
I’ve adopted a “spec-based” approach where I detail what needs to be built and with which dependencies across multiple connected spec files and then point an LLM at the first spec file and let it run.
1. Can I understand what it does from the landing page
2. How mature is the docs
…
With all the choices available today I will usually go with the one with the best docs.