I am new tp Pd, but been working on a project for a few weeks gradually added different bits and learning as I go (the project translates bird song to human language - obviously not really)

Anyway I think I am near the end of this and thinking of the best way to document. I have been inconsistent in how I have placed comments. I wonder whether I should make a help patch for each main abstraction - maybe based on the template provided which describes the function and inlets/oulets. And then have briefer comments within the patch itself clarifying how it works.

Any guidance /tips on good habits / practice would be welcome

Many thanks

Jim

I guess it was a rather vague and general question, but in reply to myself I think I would now say if I was starting the project again I would plan to develop help patches and abstraction at the same time. Or even write the help patch first which would help to clarify in my mind exactly what I was trying to do and what the inputs / outputs and gui should be (like an advanced specification) - then write the bit of the help patch that would have the testing example. Then write the actual abstraction.