2D Physics Engine

[TerryRitchie]

I'm starting to write some documentation for the engine. It's obviously a work in progress and there is still along way to go. However, I would like some feedback, to see if it clear enough and if it is informative enough for a person to make use of it. Any critique would be welcome as long as it is constructive.

Yes, your documentation is off to an excellent start.

When I make documentation I've found the best feedback I receive from readers is from documentation that contains plenty of example code to explain the idea presented. When I was a teacher I found the best approach to teaching code was through example first then analysis of the code. By having many examples the students would play with the code then go back to read the synopsis of how the code worked. Many benefited from seeing it in action first.

Another benefit to documenting I found was showing where my code needed improved. If I found it difficult or confusing to explain a concept I often took a step back to see how I could modify my code to implement the concept much cleaner and straight forward. In other words if my documentation was difficult or confusing for me to follow, it would most definitely confuse the reader.

Thank you for creating documentation. I know first-hand this is often the most difficult and tedious task to complete, but for me was the most rewarding when finished. I'm looking forward to your progress. If there is anything I can assist with please don't hesitate to ask.