3 ms·
While not exactly what the article suggests, writing the documentation for my open-source game engine [0] actually helped me improve the API itself: When I was
by Razengan 8y ago
While not exactly what the article suggests, writing the documentation for my open-source game engine [0] actually helped me improve the API itself:
When I was writing out the examples and trying to see them through the eyes of a new reader, I noticed that some simple tasks took too many lines of code, and would be a turn-off to potential users of the engine.
I felt like I should get this down to N lines, and that led me to revising the API until it could be illustrated in "prettier" examples (though there's still some work to be done.)
So yes, writing out the documentation and looking at it while "away" from the project (e.g. reading it on another device, an iPad in bed in my case, rendered on GitHub etc.) can definitely help you improve other parts of the project.
[0] https://github.com/invadingoctopus/octopuskit https://github.com/invadingoctopus/octopuskit