What would the ideal documentation system for a community driven project like Drupal look like?
From the outside Drupal is perceived as a well documented project, and several people choose to work with Drupal because of this. On the inside however, a lot of people complain about the documentation. What's the reason and the meaning of these differences in perception?
In this session I want to present the results of a survey that I'll do in preparation for Drupalcon to investigate the general level of satisfaction with the Drupal documentation system and the main areas where people think our infrastructure should or could be improved.
I'll explore how we could leverage technologies like DITA (Darwin Information Type Architecture), RDF, RDFa, and mindmaps to build a documentation infrastructure that provides solutions for these pain points. I'll also give a short introduction to single sourced documentation and DITA more specifically and the work we've been doing building a set of modules that bring DITA to Drupal.
(Drupal) documentation enthusiasts, technical writers
Comments
docs team is doing an awesome job
I believe that the docs team is doing an awesome job and this is in no way intended as criticism to their work.
I also know that with the roll out of D7 we shouldn't divert time or energy from the documentation update.
Changing the docs infrastructure however is not something that will happen overnight, so if we want to be ready to roll out improvements not too long after the D7 dust settles, we need to find out now what we want to improve.
Some background info on the
Some background info on the topic can be found: