[oe] Documentation problems

[Chris Verges]

On Sun, Nov 27, 2011 at 9:11 PM, Tom Rini <tom.rini at gmail.com> wrote:

> Does anyone reading this know people that _like_ editing wikis?  Can
> we ask them what keeps them engaged in the process?
>

Hi Tom,

This is an excellent discussion.  As someone interested in seeing some good
documentation come out of the OE project, consider that documentation is
really the way that users first interact with the software.  If the
documentation is poor, the user will more than likely seek another project.
 But if the documentation helps explain things well, the user will be able
to start interacting with the software and/or code more quickly.

Some consider a "necessary evil," but I prefer to think of it as "the
gateway to the product."  I actually do find documenting my designs and
code to be useful, as I find I can't keep track of as many things the older
I get.  :-)

On that note, as a user of OE for the past 5 years, I want to thank you ALL
for producing a great piece of software.  It's revolutionized how I start
embedded projects, and is one of those "essential" tools in my war chest.
 The "classic" docs were decent enough, but even as someone with 5 years of
OE experience, I'm having problems figuring out the new scheme fully.  I've
been waiting silently to read any docs that are produced, in fact.

I'm happy to help document, but obviously would need some knowledge
transfer to make that happen.  Catch-22, eh?

Thanks again,
Chris