Re:WTFM - Write The Freaking Manual
by leeoniya on Friday September 28, 2012 @10:43AM
(#4585739)
i'm currently writing a tutorial/manual for a library i wrote several months ago. the library took maybe 1 month to write and now the tutorial has taken 3 months. creating examples, illustrations, demos, determining and writing the sections in a sensical, progressive order takes a long time (epecially when it's done in your free time) :(, but without it, the project is DOA and no one will use it.
also, writing a tutorial has helped me refactor and decouple parts of the lib a few times to simplify and hone the API to something much more elegant than it was in the beginning. sometimes i feel like Git could have used the same kind of process to create an much more refined, wart-free API also.
also, writing a tutorial has helped me refactor and decouple parts of the lib a few times to simplify and hone the API to something much more elegant than it was in the beginning. sometimes i feel like Git could have used the same kind of process to create an much more refined, wart-free API also.