Revision of one approach, many benefits from Wed, 2013-05-08 14:01

All the topics in the test project are now ready: next stage, scrutinise them to see where I can best demonstrate links and re-use. But while I'm grappling with that side of DITA, a whole new potential benefit seems to be dawning – accessible metadata.

Most of the development teams I'm working are quite comfortable with the idea of XML even if they hadn't thought about applying it to documentation. The chance of using custom attributes in the <author> element to have some idea of who provided the information is making them sit up and take notice.

For documentation, I think it makes sense to think of the classic RACI categories:

responsible
the information owner, the person who told me "maximum power consumption for this unit is …" and gets to carry the can if the information is wrong and the unit blacks out the entire building when you plug it in
accountable
in this case, the hard-working technical author who has to deliver the documentation by a certain date
consulted
possibly less important, the people who had other ideas about the power consumption … or said "I don't know, go and talk to so-and-so"
informed
in my present situtation, people like resellers who need to know when information becomes available and when it changes

A colleague has suggested the simplified RACI model XLI (eXecute, Lead, Informed); I can see this working in a software development context, but I'm not so sure it matches the documentation process.

Still, it's interesting to say how things are beginning to stir – while remembering the Chinese curse "may you live in interesting times".

 

XML.org Focus Areas: BPEL | DITA | ebXML | IDtrust | OpenDocument | SAML | UBL | UDDI
OASIS sites: OASIS | Cover Pages | XML.org | AMQP | CGM Open | eGov | Emergency | IDtrust | LegalXML | Open CSA | OSLC | WS-I