I'll volunteer to help...

[Michael Rensing]

On Tue, 2003-08-12 at 18:36, Chris Lyttle wrote:
> On Tue, 2003-08-12 at 17:01, Jon Lapham wrote:
> > >>The FAQ is here:
> > >>http://www.jandr.org/temp/gnucashdocs/appendixb.html

As an aside to the topic: One of the problems as I see it, is that there
are so many different sites with information about GnuCash that one
never knows if one has seen everything. For example, this is the first
time I've seen this FAQ. Is it new? If not, there should be a link from
the web page.

Also, I'd suggest to those busy coding that if an answer is in the FAQ,
just point the users who ask to the URL. In fact, it seems entirely
appropriate to me that those who code should leave the RTFM's and FAQ's
to others on the users list who have the time to answer the obvious
questions.

> > >>Just send your updates to the list for discussion.
> > > 
> Well you're putting them there from the lack of an easy way for you to
> get them on gnucash.org. Hopefully soon you'll be able to put them on
> gnucash.org yourself and update it as needed.

That's what I'd prefer. I like to pee on my own corner of the world, and
have others recognize my territory. ;)

> > Well, I don't think we really have maintainers, in the usual sense, for 
> > parts of the documentation.  If Michael wants to add/edit FAQs, he (or 
> > anyone else) would be appreciated and welcomed.

Thanks. I just want to know who has been doing it so that I know who to
consult with, and who's toes to avoid.
> > 
> > However, I am a believer in Keep It Simple, and I see no reason why the 
> > FAQ should be a separate document.  We can make links to it directly 
> > from the web page, no reason why we couldn't do that.  

Agreed.

> I agree with you here, Jon, it would be best to have additions to the
> FAQ as docbook xml, but if people feel they don't know it well enough to
> write in that format they can submit it to the -devel list for
> discussion and hopefully one of us will find time to put it into XML.

That's why I offered to take over something. I can handle the XML,
whether from emacs or from OpenOffice. I don't see why someone who can
code in C and understands the GnuCash code would spend the time on
documentation if someone like me can help out.

I think the problem comes when you say (realistically) "hopefully one of
us will find time to put it into XML". That's probably why the docs are
lagging behind reality, and why y'all have less time for coding every
time a new feature is added.

> The XML format was chosen to make it easy to spit out HTML or any other
> format (like PDF) that we'd want to see the docs in. Michael I encourage
> you to join Jon and I on the gnucash-docs team to improve the
> documentation.

Love to. It's better to be part of a team anyway. How do I get started?
Is the doc on CVS? I haven't compiled from source due to the difficulty
in getting all the dependencies sorted out.

> > Now, that is just how I decided to do the FAQ, certainly not necessarily 
> > the best way.  :)  I figured that until we had a complete guide, this 
> > was the best approach.  But, I see what you mean, put the *actual* most 
> > frequently asked questions there...

Whatever works for now. I'd think that the most important thing would be
to generate the content. The format can follow somewhat after if
necessary, and can certainly be changed if needed.
 
> I have a feeling the *actual* FAQ's would be best in the wiki. But until
> that is working your approach makes sense to me.

The Wiki may be the best collaborative approach, but would it work as
the "actual" FAQ? In other words, if a newbie asks a FAQ, would you
point them to the Wiki for the answer, or would that scare them off?


BTW, I think I'm going to unsubscribe from the list as this user, and
re-subscribe using my sourceforge account. That way I may stand a chance
of dealing with the spam that is bound to result from raising my profile
on any searchable mailing list. Look for me as
"mrensing at users.sourceforge.net"
-- 
Michael Rensing
MJR Consulting Inc.
Phone: 250.704.6088
mailto:mjrconsulting at shaw.ca