Feedback request

[Karsten Wade]

On Mon, 2006-01-30 at 23:57 -0500, Debra Deutsch wrote:
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
> 
> It's been suggested that a good beginner task for me would be to
> proofread and edit the FAQ and related pages
> (http://www.fedoraproject.org/wiki/FAQ). I am happy to take that on.
> I've read the pages about writing using the wiki and wiki editing.  It's
> left me with the impression that perhaps the FAQ should be broken into
> pages instead of being one long page.

It changes some of the dynamics.  It makes it easier to collaborate,
e.g., one person can write FAQ/UsingFedora whilst the other edits
FAQ/HelpandSupport.

> What do people think of this potential change?  Is there a standard way
> to lay out a multi-page FAQ?  I am imagining that the table of contents
> would be one page.  Each of the six main topics would also become a page.

You might want to take a look at how the release notes beats are
aggregated here:

http://fedoraproject.org/wiki/Docs/Beats

You'll note that it does *not* use a [[Table of Contents]], instead
relying upon he manual list at the top.  That list lets us link directly
to the sub-pages that are [[Include()]]'d below.

Having all the content appear on one single page is a very different
experience from having to travel to separate pages.  Besides, I think
you have to pull them in with [[Include()]] in order for the [[Table of
Contents]] macro to work.

There are other things we can think about, such as defining a standard
for wiki formatting choices for content such as:

- commands
- filenames/paths
- command line options
- content from within a text file (such as a configuration file)
- etc.

I'm running across these inconsistencies with Docs/Beats/ right now. :)

- Karsten
-- 
Karsten Wade, RHCE * Sr. Tech Writer * http://people.redhat.com/kwade/
gpg fingerprint:  2680 DBFD D968 3141 0115    5F1B D992 0E06 AD0E 0C41   
Content Services                          Fedora Documentation Project
http://www.redhat.com/docs   http://fedoraproject.org/wiki/DocsProject
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: This is a digitally signed message part
Url : http://lists.fedoraproject.org/pipermail/docs/attachments/20060130/a250068c/attachment.bin