Last updated June 21, 2011. Created by add1sun on March 2, 2009.
Edited by jhodgdon, LeeHunter, Jeff Burnz, tgeller. Log in to edit this page.
This was a page for a specific sprint, which is long past now. If you are looking for information on organizing a sprint, check http://drupal.org/node/424194
-----
Please feel free to use this as a guideline for the information to provide to documentation sprint attendees.
- What's already being done at this sprint?
- What resources will help me?
- What procedures should I know?
- What general tasks need doing?
- How can I write more goodly?
What's already being done at this sprint?
What resources will help me?
- The handbook style guide.
- Links in the "Document team links" block. To turn it on: Log in, go to your user page, click "Edit", do this.
- -- Add other resources you find handy
What procedures should I know?
- Log in to IRC at irc.freenode.net, room #drupal-docs. (instructions)
- Once you've determined what page you're going to edit, put the following at the top: "This page is currently being edited by [your name]." Make sure you remove that text when you are done.
- Do most of your editing in an external text editor (such as NotePad or an email program). From that source, update the drupal.org site occasionally.
- Questions? Find someone wearing a "cat herder" button.
- -- Include links to useful resources.
What general tasks need doing?
- Basic maintenance.
- Review existing articles for sense, structure, and missing pieces. This is a good task for newbies to learn and help at the same time.
- Copyedit for spelling, punctuation, and grammar.
- Edit for style.
- Add information from comments back into the parent page ("rolling comments"). This list of handbook pages with comments is a good place to start.
- Reviewing incomplete pages and helping complete them.
- Review code. Check for standards compliance and security of code samples.
- Test code: Does the sample actually work?
- Find pages written for only 4.7 or lower, and update the page or deprecate it by moving it to the Archive handbook.
- Take a task from the documentation issue queue
- Maintain the issue queue itself: See if issues are still valid, review drafts, mark duplicates, etc.
- Work on core documentation.
How can I write more goodly?
- Write for a specific audience.
- Be brief. Use as many words as are needed, but no more
- Deconstruct. Break down ideas into small, easy-to-digest parts.
- Use simple language. Many readers are not native English speakers.
- Refactor. Some pages should be combined; others should be split. Avoid being a slave to the existing structure.
- Consult the style guide.
- Ask others for feedback. :-)