Difference between revisions of "Documentation/Contribute"
(→Getting Started: Remove references to ODFAuthors Ste and mailing list as they are no longr used for documentation.) |
(Remove references to the ODFAuthors list and web site.) |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:Contributor's 101}} | {{DISPLAYTITLE:Contributor's 101}} | ||
__NOTOC__ | __NOTOC__ | ||
| − | |||
OpenOffice.org always welcomes new contributors. No matter what your level of experience is, you can make a valuable contribution to documentation. | OpenOffice.org always welcomes new contributors. No matter what your level of experience is, you can make a valuable contribution to documentation. | ||
| Line 15: | Line 14: | ||
== High Priority Tasks == | == High Priority Tasks == | ||
| − | |||
* '''Planning''' for future documentation needs and delivery methods as part of the overall user support services for Apache OpenOffice.org. This discussion is taking place on the [mailto:dev@openoffice.apache.org ApacheOOo Mailing List] and the [https://cwiki.apache.org/confluence/display/OOOUSERS/Wiki+Home ApacheOOo Community wiki]. See above for more information. | * '''Planning''' for future documentation needs and delivery methods as part of the overall user support services for Apache OpenOffice.org. This discussion is taking place on the [mailto:dev@openoffice.apache.org ApacheOOo Mailing List] and the [https://cwiki.apache.org/confluence/display/OOOUSERS/Wiki+Home ApacheOOo Community wiki]. See above for more information. | ||
| Line 49: | Line 47: | ||
# Edit the page and make the changes and edits as needed, and save. | # 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. | + | '''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? == | == How can I help? == | ||
| Line 95: | Line 93: | ||
=== Documentation Developers === | === Documentation Developers === | ||
| − | The majority of the Documentation work is now coordinated and written here on the Wiki | + | The majority of the Documentation work is now coordinated and written here on the Wiki. 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. | 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. | ||
--> | --> | ||
[[Category: Documentation]] | [[Category: Documentation]] | ||
Revision as of 20:23, 6 April 2013
OpenOffice.org always welcomes new contributors. No matter what your level of experience is, you can make a valuable contribution to documentation.
Here are some ways you can help: writing, reviewing, editing, research, maintenance, artwork. See How can I help? below.
Getting Started
- Join the Apache OpenOffice.org Mailing List.
- Ask questions on the mailing lists if you're not sure about how to do something.
High Priority Tasks
- Planning for future documentation needs and delivery methods as part of the overall user support services for Apache OpenOffice.org. This discussion is taking place on the ApacheOOo Mailing List and the ApacheOOo Community wiki. See above for more information.
- Research to determine what questions (from the user forums) are not well answered by existing user documentation and might be good candidates for how-tos or perhaps covered in the user guides.
Ongoing Tasks
- 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
This information may be out of date and may be superceded by developments at ApacheOOo.
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.
Writing
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.
Reviewing
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.
Editing
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.
Research
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?
Maintenance
Keep pages up to date with changes in new releases of OpenOffice.org.
Artwork
Help writers by capturing, cropping, and labeling screenshots, or creating diagrams and other artwork.
Other
This information may be out of date and may be superceded by developments at ApacheOOo.
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.
