Difference between revisions of "Documentation/Contribute"
|Line 9:||Line 9:|
== Getting Started ==
== Getting Started ==
* Join the [mailto:dev-subscribe@
* Join the [mailto:dev-subscribe@..org Mailing List]. the to .listto
* Join the [mailto:
* Join the [mailto:-subscribe@..org Mailing List]and . This list is where writers, editors, reviewers, and others discuss documents they are working on.
* If you are interested in working on user guides, request an account on the [http://odfauthors.org/english/ ODFAuthors website] by asking on the [mailto:@..org Mailing List]. Having an account lets you download draft files and upload reviewed files to the website. (Self-registration for an ODFAuthors website account is no longer possible, due to spam problems.)
* If you are interested in working on user guides,
* Ask questions on the mailing lists if you're not sure about how to do something.
* Ask questions on the
== High Priority Tasks ==
== High Priority Tasks ==
Revision as of 00:22, 29 August 2011
The OpenOffice.org Documentation Project always welcomes new contributors. No matter what your level of experience is, you can make a valuable contribution.
Here are some ways you can help: writing, reviewing, editing, research, maintenance, artwork. See How can I help? below.
This page is out of date. We are working on updating it.
- Join the Apache OpenOffice.org Mailing List. This is a general discussion list and includes a lot of technical discussion about the transition from Oracle to Apache OpenOffice.org as well as discussions about user support and documentation. Browse through the list's archives to get an idea of what's been going on since early June 2011.
- You may wish to read the Transition Planning and the Documentation Plan sections of the Apache OpenOffice.org Community wiki, and perhaps get an account on that wiki.
- Join the ODFAuthors Mailing List. Introduce yourself to the team, tell us where your strengths are, and how you would like to help. This list is where writers, editors, reviewers, and others discuss documents they are working on.
- If you are interested in working on user guides, request an account on the ODFAuthors website by asking on the ODFAuthors Mailing List. Having an account lets you download draft files and upload reviewed files to the website. (Self-registration for an ODFAuthors website account is no longer possible, due to spam problems.)
- Ask questions on one of the mailing lists if you're not sure about how to do something.
High Priority Tasks
- Finish reviewing, updating, and editing the OOo 3.x user guides for Writer, Calc, Impress, Draw, Math, and Getting Started. This work is taking place both on the wiki and on the OOoAuthors website. Please see the task list and the Guide to Producing User Guides for OpenOffice.org here on the wiki. Note: User guides in English are under dual CCBY/GPL licences.
- Develop a Base User Guide. This work has begun and is being done through the OOoAuthors website.
- Update the Migration Guide from 2.x to 3.x.
- Clean up the Contributor's 101 page contents. That's this page, where you are now.
- Set up a guideline for new Doc Project members.
- Publish ODT and PDF versions of the Developer's Guide.
- Review pages in the Category:Documentation/NeedsRework. These documents need review and updating.
- Review the tasks in the Task List. Are they still valid?
- Translations to and from other languages.
- Cleaning up and converting Developer docs to formal User Guides - see Category:Documentation/Candidate
- New HowTos. e.g. tips and tricks with Base or any other module that is not something that would be in a user guide but might be useful. For example, a HowTo for creating a Flow Chart using Draw.
- Other specific features-oriented, task-oriented, or audience-oriented type short manuals/tutorials/how-tos. See this page and linked pages for some ideas.
- Review the Documentation wish list.
Contributing in the Wiki
Anyone can contribute in the Wiki by following this simple procedure:
- Set up a user ID on the OpenOffice.org Wiki.
- Read the Wiki Editing Policy.
- Look around on the Wiki and pick a topic that interests you. See in particular the pages in the Category:Documentation/NeedsRework.
- Edit the page and make the changes and edits as needed, and save.
If the changes involve a rewrite or other major work, discuss it on the Documentation Mailing list first to let the team know what you are doing. A large re-write project will need some co-ordination, and tracking.
How can I help?
Here are some ways you can help.
If you are good at organizing information, explaining concepts, and writing instructions, you can help most by writing.
Ideally you are an experienced technical writer and have good English skills. But neither of those ideals are requirements, because other people can edit your English. Or you can write in another language for translation into English.
Don't feel confident of your writing skills or your level of knowledge about OpenOffice.org itself? Reviewing documentation (especially docs aimed at new users) is a great way to start. Is it written well for the audience? Are the instructions correct? Is anything missing? Let us know what needs fixing, or correct it yourself.
Sometimes called "proofreading" though the two are not the same. Here you do need good English skills. In addition to correcting errors, editors help make the docs more readable.
Writers often don't have time to make sure existing docs are complete and up to date. You can help by reading the forums and mailing lists to see what questions users have. Is info missing from our docs, or just hard to find? Do we need a new FAQ, a how-to, or a section in a user guide?
Keep pages up to date with changes in new releases of OpenOffice.org.
Help writers by capturing, cropping, and labeling screenshots, or creating diagrams and other artwork.
We also need help with things like:
- Maintaining the Documentation Project website
- Administering and monitoring changes made in the Wiki
- Building and exporting books using Wiki Collections
- Answering questions raised on the Wiki Talk pages
New ideas are welcome. Is there a better way to do something? Let the project team members know.
The majority of the Documentation work is now coordinated and written here on the Wiki or on the OOoAuthors website. However, some site maintenance work is needed on the main Documentation Project website.
People with Developer status at the Documentation Project and CVS access to the Project's website can upload files directly to the Docs website and do other site maintenance duties. If you want to have Developer status, write to the mailing list and ask. This status is not granted automatically.