Request for peer review of the new FAQ by WW.
Nick Loeve
nick at trickie.org
Mon Nov 8 07:18:08 UTC 2004
I would love to help with a DocBook FAQ.
DocBook is definately the best way for cross-format docs.
On Mon, 2004-11-08 at 08:10 +0100, Christoph Haas wrote:
> Morning, list...
>
> On Sat, 2004-11-06 at 17:25 -0500, Alexander Poslavsky wrote:
> > Now we have a question, we could put the FAQ in docbook, both in the
> > support-pages and for use in yelp, is this needed? Will the faq be
> > incorperated in yelp for off-line reading?
>
> Unsurprisingly I vote for making a self-contained FAQ in DocBook
> format. :) Although a lot of Wiki pages already provide good
> answers on FAQs I would really like to see a carefully maintained
> document with proper sections in the TOC etc. Even some more basic
> questions like "Who makes Ubuntu?", "What makes it different to
> other Linux-derivates?" or "I used Debian - what now?" would probably
> be nice to have answers for.
>
> Suggestion:
> - I could set up a repository (anyone who does not like Subversion?)
> where the Documentation Team maintains the FAQ.
> - Everybody who wishes to contribute gets access of course.
> - As DocBook is nothing more than structured text we would have
> no conflicts when merging concurrent changes in the repository.
> - An automated repository task could automatically create a new
> XHTML page (and probably other formats like PDF) once changes are
> submitted. This would keep the FAQ up to date without the tedious
> task of converting it every time.
> - Perhaps someone follows the -users mailing list and adopts FAQs
> automatically.
> - The repository would allow easier translations of the FAQ.
> Translators can get the 'diff' since the last time and would easily
> see which parts need to be reworked/added.
>
> What do you think?
>
> Cheers
> Christoph
>
>
>
More information about the ubuntu-doc
mailing list