Open Source Style Guide

What is a style guide?

Though style guides vary greatly in scope and content, typically a style guide is a collection of references, exceptions, stylistic decisions, and warnings of common errors, to be applied to a body of content being produced. The scope usually includes grammar, syntax, and punctuation, specialized terminology and brand names. Sometimes included are guidelines for presentation style and handling of images.

Who is it for?

The style guide guides writers, editors, proofreaders and others creating or checking the content, so that editorial choices are applied consistently.

Purpose of this style guide

This guide is proposed as a model including generic content and a framework for custom content, for people documenting open source software. Your can use this style guide, or use it as an example for creating your own style guide for your project.

What this guide is not

This is not a guide to writing. While a resource supporting volunteer documentation writers for open source projects may be needed, it is outside the scope of this model.

Fedora Docs team participation

Just a note here, since the original message to fedora-docs-list requested a reply to this website.

The Fedora Documentation Project is currently discussing how to participate in this guide. I believe at least one cross-project person from GNOME is in the discussion, so you may know of our interest in participating.

If there is a single location we should be interacting with in the upstream, such as a mailing list, please let us know via fedora-docs-list@redhat.com. You must subscribe to write to the list; I believe several writingopensource.com-related people are subscribed already?

Thanks!

guide

Thank you for this step-by-step guide on writing open source. macbeth essays The instructions are short but informative.

For the last 13 years I’ve

For the last 13 years I’ve been self employed, working closely in the property development sector with a contractor friend , Dave, doing construction related tasks like painting, dry wall repair etc. More importantly, I’ve been acquiring and renovating rental properties that I rent out and manage. blackhawk tactical pants

For the last 13 years I’ve

For the last 13 years I’ve been self employed, working closely in the property development sector with a contractor friend , Dave, doing construction related tasks like painting, dry wall repair etc. More importantly, I’ve been acquiring and renovating rental properties that I rent out and manage. blackhawk tactical pants

Great article, this is useful

Great article, this is useful post. keep up posting. hypnosis

thanks

thanks for the information, very helpful for me.

------------------------
AffiloJetpack Review

technology news

they aren't necessarily elegant or beautiful. In an attempt to make open source books look prettier, and more legible, I propose tackling the problem at the style sheet level. If you've created style sheets you would like to share, please add them here

Nice Post

Its a good information about how can we use style guide,what is it and what is the purpose of it.
Read it carefully and then use it.

Thanks
.....................................................
Canada Online Pharmacy
Canadian Online Pharmacy

Wow..The stuff of champions

Wow..The stuff of champions should I add.

casino bonus

very nice tutorial, here all

very nice tutorial,

here all thing explain in technical point of view. after reading this,
We believes that creating a successful web presence should be easy and affordable.

here one of the world’s largest independent web hosting providers
take a look of these .....................
Web Hosting India: all about Web hosting.
Reliable Web Hosting India professionally managed web hosting solutions.
Website Designing India cheap web designing services for corporate.
Domain Name Registration choice of registrars OpenSRS and Public Domain Registry.

Writers

I myself am not a very good writer. One thing I have always struggled in is English. This was in high school though. I believe now I can write a lot better than I did way back then. Your tips have helped a lot as well. Just reading the introduction was great and I hope more of your users read it. One thing a lot of people aren't the greatest at in our society would be writing in my opinion.

Joshua
baby jumperoo
Hawaii wedding photographer

Use bulleted or numbered

Use bulleted or numbered lists instead of long paragraphs. Only use tables where it is absolutely necessary for organising the information. doctors san francisco

open source process

Great information, Open source is developed collaboratively so that the source code is freely available for use and modification.

Web designing india

Montreal Web Design

when writing an Open Source

when writing an Open Source document, the author will often wish to cite his or her sources or point the reader to a more complete document. The Style Guide will decide on a standard for references and bibliographic entries (MLA, Chicago Style, APA, or ???) and also create templates for references that the standard reference guide does not contain. (Anyone know of a standard that covers man pages?)
muscle building

This is nice post which I was

This is nice post which I was awaiting for such an artice and I have gained some useful information from this site. Thanks for sharing this information..
kitchenblog

..

This is nice post which I was awaiting for such an artice and I have gained some useful information from this site. Thanks for sharing this information.. Medyumlar

Theft Los Angeles

well very nice posts, good luck carry on.Theft Los Angeles Theft Los Angeles

paintballing

Paintballing.co.uk offer the very ultimate ‘paintballing experience’ and have highly experienced and friendly staff on hand to make sure you day out is a huge success.paintballing