I just watched a nice presentation by Yahoo evangelist Christian Heilmann who opened the show at FF09 yesterday. Whilst there’s a lot of good ideas throughout regarding the maintainability of JavaScript code, one nugget stood out about code tutorials. Christian Suggests a four pronged presentation strategy when writing tutorials for designers – it is equally valid when presenting concepts to fresh geeks:
- Say what it does.
- Show a working example.
- Include the full code of the example.
- Explain the example using code chunks interspersed with descriptive paragraphs.
A simple & sensible blueprint!