Now that we're in Open Beta, we're getting to see how actual people who aren’t us are using the site, and this is letting us know how we need to revise our documentation and, of course, write more.
One of the things we're viewing with enthusiasm now that many of our tasks are no longer as time-critical is the opportunity to allow many more people to participate in our process. In the past several months, a lot of people have wanted to get involved in site documentation, but there were a number of reasons we couldn't accept all the help that was offered.
We have now remedied that small problem.
The new community dw_docs_training
is intended as a dedicated work and training environment for new volunteers, experienced members of the docs team, and for anyone who's working on related aspects of the GUI, such as the site copy team and the site styles team. dw_docs_training
will be a closed, moderated, response-screened community so we can concentrate on the training and support aspects of docs writing.
, we'll expect you to write material off a supplied prompt and we'll the result in the community for critique. To ensure the critiquing process remains useful and focused, your sample exercises will be re-posted by one of the community moderators, and all comments will be unscreened at the same time, and only when everybody who needs to comment on the entry has commented.
Your material will be judged by three criteria: accuracy (does the site behave in the fashion you indicate?), clarity (can an inexperienced or confused reader understand what you've written and follow any directions included?) and conformity with the Dreamwidth style as laid out in the Manual of Style.
If you are participating in the community as a proofreader or copyeditor, the procedure you'll follow will be similar, except you won't be posting entries, you'll be commenting on the entries of others.
In addition to participating in dw_docs_training
, all volunteers in training will be expected to read all
of the FAQs. Not only will this give you a broad familiarity with the documentation, there are many places in which it hasn't yet reached perfection: this will be your chance to see if you can find errors.
You'll also need to familiarize yourself thoroughly with the Dreamwidth Manual of Style and the Dreamwidth Site Terminology, both of which can be found on the Dreamwidth Wiki.
The Dreamwidth Manual of Style: http://wiki.dwscoalition.org/notes/Manual_of_Style
The Dreamwidth Terminology Notes:http://wiki.dwscoalition.org/notes/Terminology
What we want out of this process, and we hope you want it too, is for you to be able to write a FAQ or other piece of site copy to site standard language, or (if you aren't one of our writers) to be able to review a piece of site copy, detect typos and other problems, identify those areas in which it does not meet the Dreamwidth standard, and prepare useful revision notes for its author.
We'll be posting the details of how to apply to the Docs Team here in dw_docs