Hacker News new | past | comments | ask | show | jobs | submit login

People joke about militaries writing docs about the exact number of turns each screw can take, but a-10 are still airworthy and the last one was built in the 80s

Quips aside, software life expectancy matters, so total documentation approach is not something that works for everything. But if your software has generations of developers, maybe it's worth thinking about it.

That or a total rewrite every skip generation. I can see both working, and maybe total rewrites are a better approach in a world of ever changing requirents.

Thing is, documentation is great to capture static knowledge, and a evolving software is not static by any means

If I had to pick and choose, I'd say written requirements with change management for every domain object APIs within the software object model, and anarchy underneath.

The code conforms to the requirements, and not the documentation conforms to the code, so to say. Contract driven, in a way, but only where it's relevant.




> Thing is, documentation is great to capture static knowledge, and a evolving software is not static by any means

There are many open source projects with great documentation and they manage to keep abreast of changes.

This attitude among programmers that documentation is hard, so don’t bother is just that - attitude.


> and they manage to keep abreast of changes

With varying degrees of success.


the documentation for something like angular or rxjs is about how to use the framework, the documentation doesn't explain the underlying code...




Join us for AI Startup School this June 16-17 in San Francisco!

Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: