Could you please include 'documentation for developer' into your proposal? This is much needed if we need another developer to take over and maintain or expand the developed codes.
@cube Actually, from the very beginning, when
@abit offered to implement this BSIP, it was my intention (and part of the "deal" with abit) to make documentation an important part of the worker proposal.
As abit has already declared, he is not very keen on writing detailed descriptions so I offered to team up with him and take on this task.
My offer is based on the assumption that abit will be willing to share with me his know-how and help me with understanding all the nuances and decisions he's made when doing the coding.
So there are going to be two tiers of documentation:
(1) in-code comments by abit
(2) a detailed documentation/tutorial, written by me, explaining the whole context, i.e. some kind of guide for developers willing to follow in abit's footsteps
This is a fragment of my PM sent to abit earlier on today:
I wrote to abit:
Ideally, we could "sell" the worker proposal as a double benefit for the ecosystem:
- for the blockchain: a new functionality that opens up BitShares to tips and micro-payments
- for the whole ecosystem: a detailed description how to implement stuff without relying on CNX so that other coders & entrepreneurs can follow our example
To which he replied:
Regarding to docs, if you're going to write it, of course I will help you.