Re: FAQ in docs

[Eric Baudais <baudais okstate edu>]

Arlo Rose wrote:
> 
> > What do you think about including the application's FAQ in the docs?  Is
> > it a good idea or a bad idea?  Any thoughts on it?
> 
> It's a very good idea.
> 
> Most professional documentation has  "Troubleshooting" section towards the
> end of it, and this fits well with that convention.

Well, IMO, most FAQs for open source apps are more the developer's
reasoning behind some development decisions that may have left out some
features and such.  Or explanations about why somethings are slower than
others, which impact the app, but don't have anything to do with the
program itself, like theme choice and such.  I don't see them as
Troubleshooting sections, per say, but more as stupid, and not so
stupid, questions that get asked by developers.

An example that comes to mind is for PAN.  They have some erroneous news
items about a non-existent company.  A question for the FAQ could relate
to that.

Eric Baudais