Over the past couple of days I've discovered that the code for project Polyrex-Parser isn't helping me much in understanding quickly how the thing works. I've managed up until now to troubleshoot projects without too much difficulty however there are a few projects which are technically complex because of their recursive nature combined with multiple conditional code statements.
Ideally I would have written design documentation prior to implementation yet my interpretation of agile is to start of small, get things working, and keep building it up slowly.
Rather then manually document each method and how it relates to the flow of the process I would prefer to have that kind of documentation generated for me. I've looked at what's currently available (i.e. Yard, RDoc) and it doesn't do what I need.
Using my Carbolic gem it would instantiate the object and then running though a test it would generate the documentation including what method was called and by what caller. Once I understood how any particular method worked I could document it in the code and then run Yard or RDoc.
I don't want this documentation project idea to take up more time than necessary. Perhaps a couple of hours a day within a week would be adequate.