[Nitro] Nitro/Og cheat sheet styles/ideas/levels....
rob at robmela.com
Sat Nov 3 12:10:38 EDT 2007
I would first ask what is it we want to produce. In other words:
1) What topics need to be covered
3) A list of use cases and the format that serves each
#1 would require input from George and Tom -- it would leverage their
time really well. This could start before documentation does.
Reflexively, based on past experience, I see these three formats. It
should be reexamined with use cases:
2) Reference ( Quick vs Complete )
My fault as an engineer is prematurely jumping to nuts-and-bolts
"How". This is a tangent -- but I'd love to see a design for reusable
components that each format can built itself from -- e.g., a Topic
class, with CodeExample, Synopsis, RelatedTopics.
Finally, it makes sense in all of this to see what's been done
elsewhere, and for people like me to spend more time reading through Oxy
and look at other docs we like.
Mark's suggested these, and I think Tom's suggested others (so much
going on here -- time to collate the major points on a wiki ?
Mark Van De Vyver wrote:
> Hi Devs,
> One issues the following examples raise is what is the level the cheat
> sheet is aimed at? 'Beginner howto cheat sheet' vs 'Reference cheat
> Even if there is initially only be one, later there will liley be
> more, so it seems worth thinking about nomenclature.
> kicking this off with Og since that seems to be the first to be tackled:
> Cheat sheets:
> - Og-howto
> - Og-reference
> Which of these cheat sheets are we starting on?
> Existing examples/ideas
> Some information packed (reference) cheat sheet examples (for ideas):
> Some more 'graphical' ones (beginner/explaining ideas)
> Nitro-general mailing list
> Nitro-general at rubyforge.org
-------------- next part --------------
A non-text attachment was scrubbed...
Size: 116 bytes
Desc: not available
Url : http://rubyforge.org/pipermail/nitro-general/attachments/20071103/152464e1/attachment.vcf
More information about the Nitro-general