So, I've recently become a member of the documentation team, and part of my proclaimed reasoning was to facilitate the integration of dojo-produced documentation into the handbooks on Drupal.org. If anything is unclear or you need help with a a dojo-doc project - feel free to ask me. IRC is also a good place to catch me.
To that end, here is a guide on getting documentation into the handbook. It's a wiki, so feel free to edit if you see I've made a horrible mistake somewhere. Additionally, there is lots of writing on how to do this on drupal.org, but think of this as the 'quick guide', of steps to take to make your doc a reality.
Additionally, if you don't have time for all this but feel something should be in the handbook, file a feature request, as with ALL issues, more details are better. "The handbook needs to be easier to navigate" doesn't help anyone. Also, try to be reasonably well informed on the discussions going on in this regards before telling everyone we're doing it wrong ;)
And as always, the documentation team is looking for help.
- Determine if documentation exists already on this topic This can be
done through:- A Search, on D.O., restricted to 'Book Pages' and 'Issues'; don't forget to click on the advanced search link, which gives a lot of flexibility in your searches, including the possibility of narrowing down your search with taxonomy.
- A perusal of the existing handbook pages.
- Asking in #drupal-support on IRC.
- Create an issue in the documentation queue describing whatever it is you want to do. This does several things:
- It lets others know what you are working on so they can help or discuss the project in an organized format place.
- It allows the doc team to know what you're doing, and offer assistance as they can.
- It gives the project a life beyond yourself. This way, if you get busy or die, other people can carry on with your great idea.
- Read the handbook style guide, and the doumentation writers guide for best practices. This way a doc team member won't need to come after you and clean up your valuable insights.
- Create a book page. Yup, you. Everyone with a drupal.org account can create a book page. Go ahead, take a whack. Things to consider:
- Where will this page want to be in the overall handbooks. This will be good to put in your issue as well.
- Is my documentation version independent? Can it be?