DEV Community

Discussion on: How to write good documentation

Collapse
 
outsourcedev profile image
outsource.dev

I think the most pragmatic and useful ideas for documentation as of today are:

Heavyweight forward engineering , ie CASE tools, UML etc have been skipped as newer engineers jump into agile and hacking code fast and a few years later we are now having issues with maintaining codebases and building big systems.

Reverse engineering ie code back to diagrams was an emergency measure and gave some assistance.

Living documentation is a great idea but tools are not quite there yet but I am hopeful, they need to be easier to use and more consistent, but I feel this will be the next pragmatic step.