Re: FAQ in docs



> 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.

Any FAQ questions that would be included in an application's documentation
should be contextual to the application itself.  If an app has inappropriate
information in their FAQ, then they haven't done a very good job separating
the application's FAQ from the application author's FAQ.

Perhaps an appropriate place to start would be to say, "If you are adding
your application's FAQ to its documentation, please be sure to pare out any
non-essential, or inappropriate question that don't apply to the general
usage of your application."


Cheers,
Arlo Rose





[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]