One thing I have learned (about myself) is this: first you write a cool piece of library/framework/tool/... and you make it as good and as clean as possible (first iteration).
When you write unit tests (which you should do during development, let's leave in the middle whether that should be before or after ;-), your code will improve (a lot) because you have to make things cleanly testable (which can be hard). Quality improves. Then you write methods and class comments (again, before or after) and you realise that thing are hard to explain which will lead you to refactoring, renaming, cleaning and adding missing pieces. Quality improves. Finally, you (try) to write the high level overview document. You want to prove how good your stuff is, you want to have nice, clean examples. Again you will change stuff because of what you learn trying to explain yourself. Quality improves. After to you publish, feedback and contributions come in. Quality improves. Do a couple of these cycles. Quality goes through the roof ;-) It sounds harder than it is, but it is worth it. And Spec already has lots of the required pieces, I think it just needs some polishing. On 09 Jan 2014, at 18:28, Benjamin <benjamin.vanryseghem.ph...@gmail.com> wrote: > As usual the problem is that it takes time :) > (and also that I am a newbie when it comes to write :P) > > Ben > > On 09 Jan 2014, at 14:26, Sven Van Caekenberghe <s...@stfx.eu> wrote: > >> >> On 09 Jan 2014, at 18:14, Benjamin <benjamin.vanryseghem.ph...@gmail.com> >> wrote: >> >>> For Spec, I actually sent a mail in the mailing list when integrated >>> explaining how to move to the new version :) >>> But indeed, not enough documentation about it is present, this is why I am >>> currently spending time writing some :P >>> (but you already know that :P) >>> >>> I think the overall remark is good :) >>> We should not integrate things in Pharo if they are under tested (Spec >>> included). >>> >>> I think that the next month will be spent on writing more tests or Spec >>> >>> Ben >> >> Yes, some good, high-level, independent docs (like a book chapter) combined >> with unit tests will improve things a lot. And there are already existing >> examples. >> >> We'll get there, I am sure. >> >> Thanks for all the efforts. >> >> Sven >
