Call for help: "How do I...?" Documentation

Cheetham, Anastasia acheetham at ocad.ca
Fri Feb 4 17:36:02 UTC 2011


Part of our plan for the new documentation is to create a collection of "How do I...?" pages: Short tutorial-style pages that provide code snippets (and hopefully working example) describing how to do a particular thing, be it with a component or with the framework.

I've posted a mind-map on the wiki showing the kind of structure I'm considering for these pages. This map is by no means complete - I'm hoping it will be expanded with many topics:
  http://wiki.fluidproject.org/x/6gFCAQ#DocumentationRedesignMindMaps-Infusion%22Help%22Topics

We're looking for volunteers to help create some of this content. If you have ideas about how to explain something, write them up! If you've recently figured out how to do something with Infusion, write it up!

If you're still learning about Infusion, don't think you have nothing to contribute: explaining something to someone else is the best way to learn it.

Ideas for topics we'd like to cover:
- using the Event system (e.b. How do I register an event listener? How does a component fire events?)
- how to customize a particular option for a particular component (e.g. How do I configure the Pager's columns? How do I customize the grab handle for the List Reorderer?)

The possibilities are almost endless. If you're interesting in helping, dive right in. Don't worry about format, or where it should live. We will find a home for it. If you'd like to help but don't know where to start, let me know: email me or ping me in the channel, and we'll find the perfect place for you.

-- 
Anastasia Cheetham     Inclusive Design Research Centre
acheetham at ocad.ca            Inclusive Design Institute
                                        OCAD University




More information about the fluid-work mailing list