Fedora Documentation Style Guide

Edward Haddock edward.haddock at hawaiiantel.net
Thu Jul 6 02:10:05 UTC 2006

On Wed, 2006-07-05 at 01:53 -0500, Patrick W. Barnes wrote:
> On Tuesday 04 July 2006 12:46, Edward Haddock <edward.haddock at hawaiiantel.net> 
> wrote:
> >     I have been working on the Documentation guide specifically on the
> > section that deals with setting up accounts and the tool chain. Maybe
> > this could be added to the Documentation guide as a reference or primer
> > on how to write with a style fro the Documentation Project.
> > http://fedoraproject.org/wiki/DocsProject/DocumentationGuide
> > 	Together the two would give new volunteers the needed information on
> > how to setup and use accounts and mail lists and show them a broad sense
> > of style to help maintain a consistency throughout the Documentation.
> > There is Section VII which is labeled Style Guidelines.
> > 	On that same page I did section II. B. but I can't figure out how to
> > get the numbers to carry on correctly after the Code piece. Any thoughts
> > or suggestions would be much appreciated.
> My goal with the Style Guide is a much larger and more detailed guide than we 
> would want to include as part of the Documentation Guide.  I do feel that the 
> Documentation Guide should continue to carry a chapter on style, and I think 
> using the Style Guide as a base in creating that chapter is a good idea.  The 
> Documentation Guide could carry a brief overview of what the Style Guide is 
> and how it is valuable.  It could also summarize the key aspects of the Style 
> Guide, but it could simply point readers to the Style Guide for the more 
> extensive style information.
	Actually that sounds like an awesome idea. If you pass anything along
to me I can try summarizing it best I can. My writing is not the best in
the world and I am learning as I go. I am also quite new to Linux/Gnu
and Fedora Core 5 so I am learning as I go there as well. I will work on
Section VII if you would like to pass along Chapters to me. I will read
them, hopefully learning and improving my own skill, then summarize and
add them to the Documentation Guide. Sound like a plan?
> I've also taken the liberty of fixing the numbering for you.  The trick is to 
> place whitespace ahead of the tables or code blocks, just like you do with 
> the various numbered list elements.
> I. Subject One
>  1. First Thing
>   {{{
> code
> }}}
>  1. Second Thing
> I. Subject Two
>  || Table ||
>  1. First Element
>  1. Second Element
> ...
	Many Mahalo's, Thank you in Hawaiian, for that. I looked at what you
did and saw a few other things to fix. So I learned something new. :)
> -- 
> Patrick "The N-Man" Barnes
> nman64 at n-man.com
> http://www.n-man.com/
> LinkedIn:
> http://www.linkedin.com/in/nman64
> Have I been helpful?  Rate my assistance!
> http://rate.affero.net/nman64/
> -- 
> fedora-docs-list mailing list
> fedora-docs-list at redhat.com
> To unsubscribe: 
> https://www.redhat.com/mailman/listinfo/fedora-docs-list
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 189 bytes
Desc: This is a digitally signed message part
URL: <http://listman.redhat.com/archives/fedora-docs-list/attachments/20060705/df1966d6/attachment.sig>

More information about the fedora-docs-list mailing list