Difference between revisions of "Documentation/Contribute"
From Apache OpenOffice Wiki
(→Prerequisites) |
(Reorganised page, slightly rewrote some points, added refs to OOoAuthors website) |
||
| Line 2: | Line 2: | ||
__NOTOC__ | __NOTOC__ | ||
The OpenOffice.org Documentation Project always welcomes new contributors. No matter what your level of experience is, you can make a valuable contribution. | 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. | ||
| + | |||
| + | == Getting Started == | ||
| + | |||
| + | * Join the [mailto:Dev-subscribe@documentation.openoffice.org Documentation Mailing List]. Introduce yourself to the team, tell us where your strengths are, and how you would like to help. | ||
| + | * Become a [http://documentation.openoffice.org/servlets/ProjectMembershipRequest member of the Documentation Project]. | ||
| + | * Read and understand the [http://www.openoffice.org/project/www/license.html Licences] used within the Documentation Project. | ||
| + | * Check the lists of high priority and ongoing tasks below and pick something that interests you. | ||
| + | * Ask questions on the Documentation mailing list if you're not sure about how to do something. | ||
| + | |||
| + | == High Priority Tasks == | ||
| + | |||
| + | * Review, update, and edit 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 [http://oooauthors.org/english/ OOoAuthors website]. Please see [http://oooauthors.org/english/ this page for instructions on how to contribute]. Note: User guides in English are under dual [http://creativecommons.org/licenses/by/3.0/ CCBY]/[http://www.gnu.org/licenses/gpl.html GPL] licences. | ||
| + | * Develop a Base User Guide. This work has begun and is being done through the [http://oooauthors.org/english/ OOoAuthors website]. | ||
| + | * Clean up the Contributing 101 page contents. | ||
| + | * Set up a guideline for new Doc Project members. | ||
| + | * Publish ODT and PDF versions of the Developer's Guide. | ||
| + | * Update the Migration Guide from 2.x to 3.x. | ||
| + | * Review pages in the [[:Category:Documentation/NeedsRework]]. These documents need review and updating. | ||
| + | * Review the tasks in the [http://www.openoffice.org/issues/buglist.cgi?issue_type=TASK&component=documentation&issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED Task List]. Are they still valid? | ||
| + | |||
| + | == 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 type short manuals. | ||
| + | * Review the [[Documentation/Wishlist|Documentation wish list]]. | ||
| + | |||
| + | <!-- | ||
| + | *Find items to post to the [http://documentation.openoffice.org/articles/index.html articles and reviews] section. Attach the items to [http://www.openoffice.org/issues/show_bug.cgi?id=47818 Issue 47818] and mention them on the list. | ||
| + | *FAQs: Any help with updating the FAQs would be greatly appreciated. [[Documentation/FAQ|This work is taking place on the wiki.]] | ||
| + | *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. Check the Task List for suggestions, or start a new issue for a new HowTo. This work is taking place on the wiki. | ||
| + | *Other specific features-oriented type short manuals. | ||
| + | *Samples and templates. More are needed to add to [http://documentation.openoffice.org/Samples_Templates/index.html this page]. | ||
| + | *Links to other OOo projects' documentation, to add to what is on [http://documentation.openoffice.org/project_list.html this page]. | ||
| + | *Translations from other languages. A few from French and German have been done but there is much more that could be in English. | ||
| + | --> | ||
| + | == Contributing in the Wiki == | ||
| + | |||
| + | Anyone can contribute in the Wiki by following this simple procedure: | ||
| + | |||
| + | # Set up a [[Special:UserLogin|user ID]] on the OpenOffice.org Wiki. | ||
| + | # Read the [[Documentation/Dashboard/Wiki_Editing_Policy|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. | ||
| + | <!-- | ||
| + | #See the [http://www.openoffice.org/issues/buglist.cgi?issue_type=TASK&component=documentation&issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED Task List]. | ||
| + | #Log in and go to the task number in IssueTracker. | ||
| + | #Add yourself to the CC: list, and add a comment to the issue to say you are working on it and what you are doing. | ||
| + | #Get any relevant downloads from the issue. | ||
| + | #When you have something to contribute (a new or revised file), upload it to the issue, and tell the mailing list what you have done so other people can comment. | ||
| + | #Revise the file as needed after comments are received. | ||
| + | #When everyone, particularly the project leads, are happy with your work, they will upload it to the main Docs pages and link to it. | ||
| + | --> | ||
== How can I help? == | == How can I help? == | ||
| − | Here are some ways you can help | + | Here are some ways you can help. |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
===Writing=== | ===Writing=== | ||
| Line 18: | Line 68: | ||
If you are good at organizing information, explaining concepts, and writing instructions, you can help most by 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. | + | 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=== | ===Reviewing=== | ||
| Line 50: | Line 100: | ||
New ideas are welcome. Is there a better way to do something? Let the project team members know. | New ideas are welcome. Is there a better way to do something? Let the project team members know. | ||
| − | == | + | === Documentation Developers === |
| − | + | 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. | ||
<!-- | <!-- | ||
| − | + | Once you have received Developer status, you will need to get CVS access. [http://documentation.openoffice.org/faqs/site_maintainers/index.html This page] has links to FAQs on the subject. The instructions need to be consolidated and rewritten. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
--> | --> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
[[Category: Documentation]] | [[Category: Documentation]] | ||
Revision as of 11:16, 2 January 2010
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.
Getting Started
- Join the Documentation Mailing List. Introduce yourself to the team, tell us where your strengths are, and how you would like to help.
- Become a member of the Documentation Project.
- Read and understand the Licences used within the Documentation Project.
- Check the lists of high priority and ongoing tasks below and pick something that interests you.
- Ask questions on the Documentation mailing list if you're not sure about how to do something.
High Priority Tasks
- Review, update, and edit 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 this page for instructions on how to contribute. 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.
- Clean up the Contributing 101 page contents.
- Set up a guideline for new Doc Project members.
- Publish ODT and PDF versions of the Developer's Guide.
- Update the Migration Guide from 2.x to 3.x.
- Review pages in the Category:Documentation/NeedsRework. These documents need review and updating.
- Review the tasks in the Task List. Are they still valid?
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 type short manuals.
- 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.
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
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.
Documentation Developers
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.
