One of the most effective practices I've found for documentation is something I call test-driving. A test drive is when you follow the steps yourself in any procedural documentation and verify that they work the way you think they do. After a test drive the documentation is far more accurate and useful than documentation that has not been tested. (This works even if you're the engineer who wrote the software.)
Test driving the documentation
Test driving the documentation
Test driving the documentation
One of the most effective practices I've found for documentation is something I call test-driving. A test drive is when you follow the steps yourself in any procedural documentation and verify that they work the way you think they do. After a test drive the documentation is far more accurate and useful than documentation that has not been tested. (This works even if you're the engineer who wrote the software.)