3 ms·
Documentation is such a broad area I think it's big enough for everyone to hate something. There's - how (implementation, how the system works) - what (what
by nijave 3y ago
Documentation is such a broad area I think it's big enough for everyone to hate something.
There's
- how (implementation, how the system works)
- what (what the system is for, it's purpose
- why (design)
And there's audiences
- developers (using the interfaces)
- architects (designing the interfaces)
- testers (validating the interfaces)
- operators (running the system)
- managers (organizing development efforts)
And at some companies it's 1 person doing all of that. I think once you start to add more people, you start to have debates about documentation. The programmer might have written "clean" code and automated tests which are understandable to other programmers but less useful to project managers and operators.