Great Link: Learning Documentation From a Croissant



I couldn’t even spell croissant without looking at the title of this article, but now I am going to learning something from it!

Opensource.com: I can’t bake croissants: a fable on project documentation

This is a great link to remind you how to approach documenting.  If I could add one thing — a picture is worth a thousand words!  For me, that means use Shutter like crazy.  The pictures help clarify things for users who are not as familiar with the topic yet they don’t slow down users who are more familiar with the topic.  It’s a win-win situation.

Furthermore, these principles apply both to traditional documentation and blogging.


Share