The GNOME Documentation Project

News

• 2006-07-08 - There has been much work recently on the wiki, notably GNOME Documentation Project pages are now categorized and there are several new pages, such as the

  contributing page.

• 2006-03-17 - Have you seen our

  Review at Linux.com? We've put a lot of work into Gnome documentation in the past few weeks, and it's great to see it having some effect.

We need user-feedback most of all. What do you think of

Help, Yelp and Gnome docs. in general in this new release? Please add your comments to our Feedback page.

Helping out

Currently, any help our team can get would be fabulous. We're always searching for new contributors. Whether you are looking to help the GNOME or open source community at large documentation can be a great place to start.

Helping us does not necessarily require any specific knowledge, you can start to contribute immediately and learn as you go on. Writing documentation can be a great way to join the open source community, discover the creative process and how to use such things as mailing lists, CVS or software build systems (compiling). To find out how to contribute to the GDP, take a look at our page on

contributing. If you are serious about pitching in, find out how to join the team at our page about joining the GNOME Documentation Project.

Current work

• Terminology contains our current efforts to revamp the terminology guidelines in GNOME.

• Tasks is a list of current tasks we could use your help with. You do not necessarily need skills with !XML/DocBook, or CVS/SVN, or building GNOME from source. We need writers, editors, proofers, testers and technical advisors. We need you.

• GDP Roadmap — You can make a difference.

• DocumentationProjectPolicies

• CodenameGraphite - may change its name later

For the future, we'd like to know what you expect from

ideal developer documentation. See also Developer Guides.

Team Meetings

We hold semi-regular team meetings. Please join if you can.

• 2008-02-03

More information

• GnomeDocUtilsCreateNew - instructions for writing new documentation

• GDP Hompage - beware this page contains much outdated information.

• Contact the GDP

• List of wiki pages concerning the GDP

• Status of migration of core GNOME modules to gnome-doc-utils

• Where to find documentation in CVS

• /YelpLinks

Documentation Tools

• Gtk-Doc used to build API docs (future features)

• Gnome-Doc-Utils build system for documentation (better support for docs translation, see MigrationHowTo)

Links to existing documents

Technical docs:

• Guide to Developing GNOME apps, by Elijah Newren.

• GNOME Hacker's Kickstart guide, by GNOME Bangalore contributors

• Using jhbuild on Novell Linux Desktop, by FedericoMenaQuintero

• [

  GtkBook] This is a space for writing the GtkBook project, by Muthiah Annamalai.

Resources:

• Templates for manuals and guides

History, big-picture, documents of sentimental value:

• 101 Things To Know About GNOME, by Glynn Foster (openoffice .sxi)

• The Story of the Gnome Project, by Miguel de Icaza

• Let's Make Unix Not Suck, by Miguel de Icaza

• Helix Code, the Gnome Company, by Miguel de Icaza

• Musings on what is needed for a gnome-libs 1.0, by the hackers of the now-defunct Red Hat Advanced Development Labs.

---

CategoryDocumentationProject