Structured Collaboration, Wikis, and Getting the Job Done
Collaboration happens when multiple people work simultaneously towards a common goal. Collaboration software are tools which try to make working together easier and more productive.
There are hundreds of methodologies and approaches out there to collaboration. We want to bring the focus on one particular dimension: open vs. structured collaboration.
These are two different schools of thought.
The paramount of open collaboration is the well-known Wiki. A wiki allows anyone looking at content to comment and edit. Wikis make for a pretty ideal democracy in that people have pretty much the same rights towards content, at least the right to comment and edit. The underlying principle here is that if readers can contribute by acting directly on content then the quality of the content will quickly and incrementally improve and always be up-to-date. Its power resides in the cumulative brainpower of the crowd, its vulnerability in its openness. Wikipedia.org became in a few years the first online destination for reference knowledge, yet the authority of its content is by construction always questionable.
The idea of structured collaboration is to map an actual workflow (i.e. a set of rules) to the collaboration software. Users are assigned roles which give them permissions to do things the same way they would offline, or without the software. The underlying principle is that the software is a guide that lets you do exactly what you have to so you play your part in the well-oiled collaboration process. Structured collaboration works only if the underlying workflow is adapted to the task at hand. Therefore, structured collaboration solutions are usually specific to a task (like LiveTechDocs is for documentation review), or adaptable (enterprise resource planning software like SAP could be extrapolated as structure collaboration software for the whole company), or correspond to general needs (like Producteev is for task management).
The key here is to understand that if collaboration is a very general concept, choosing a collaboration software has to be very specific to the common goal assigned to the team. Better performance can be reached for some objectives through open collaboration (for instance tasks requiring significant creativity, fact-checking, moderation), while in other situations teams will perform best with specific and structured collaboration software (for instance tasks involving streamlined processes, time constraints, systematic involvement of team members, or tasks requiring authority, validation, accountability).
Even if you are opting for the benefits of open collaboration, choosing the right wiki has to be done in consideration of all aspects of the project and objectives. If you are going the wiki route, take a look at this map (Wiki Choice Wizard included) so you won’t get lost in wiki-land.
Now, let’s narrow this down to technical documentation, shall we. Collaboration is needed for various steps of the technical documentation process. Authoring and editing documentation can be a collaborative process, for one. Reviewing documentation, obviously (you saw that one coming, did you). Getting user feedback on released documentation is another one.
On authoring and editing, documentation team practices can be translated either to open collaboration and structured collaboration. From the wide open practices of O’Reilly (see the Open Books Project) to the one-writer-per-documentation process, the way companies do their documentation business is what is going to translate into the optimal collaboration solution.
On getting user feedback, Wikis are definitely a seducing approach, but when implemented new questions have to be answered and positions taken, as it raises the question of who has control on publicly available content. These questions go beyond the realm of usual novel technology implementation. Such questions could be, Do I moderate user input? Do I respond to criticism, do I moderate it, do I delete it? What’s constructive criticism, what’s offensive content? Do I edit false user generated content? Do I respond to it? These are business decisions that have ethical ramifications, that should be clearly stated and enforced in a set of company policies. If you’re asking yourself these questions we suggest reading and following Atlassian’s Sarah Maddox blog (@sarahmaddox on Twitter) who’s been working and writing extensively on the subject.
Last but not least, on documentation review. Our belief here is that structured collaboration is the best solution to improve performance. We designed a structured collaboration workflow where documentation stakeholders are assigned roles (reviewer, writer, manager, administrator) with specific rights and duties. We worked on this workflow with technical documentation professionals for more than a year to find the sweet spot between directivity and openness. Directivity so companies achieve optimal performance (time, quality, money) in the specific process of documentation review, openness so each company can map its way of doing documentation review business to our workflow.
What’s your approach to collaboration in the different steps of technical documentation production and maintenance? What’s your take on open vs. structured collaboration?
4 responses to "Structured Collaboration, Wikis, and Getting the Job Done"
3 Trackbacks
-
[...] LiveTechDocs – Documentation collaboration service community.livetechdocs.com/voice/2009/08/wikis-structured-collaboration – view page – cached Collaboration happens when multiple people work simultaneously towards a common goal. Collaboration software are tools which try to make working together easier and more productive. There are hundreds of methodologies and approaches out there to collaboration. We want to bring the focus on one particular dimension: open vs. structured collaboration. — From the page [...]
-
[...] Structured collaboration, wikis, and getting the job done [...]
-
[...] writing and editing. We’ve shown you what we think of this in a previous post on wikis and structured collaboration. Today we dig a bit [...]
One Comment
Hallo Jeff and all the LiveTechDocs people
Great post — Lots of food for thought and conversation here! BTW, I do love the design of the whole LiveTechDocs site. It’s very attractive and appealingly simple.
Your post makes a very interesting and valid distinction between open and structured collaboration. Like you, I think that particularly for document review, the two approaches are equally valid and useful in different situations.
Where I’m working now, we write documentation for web-based, frequently-revised and rapidly-developing software applications. Not surprisingly, the documentation fits the same pattern. For our needs, the less structured method of collaboration works best. Tech writers, developers, all staff and even community authors can add, update and review documents.
Even so, we need to ensure that our documentation gives our customers an authoritative guide to the software. We use a wiki, arguably the most open type of collaboration tool. If people think a page is incorrect, they simply update it.
We depend upon a certain amount of trust that our authors will do the right thing. And they do. We do ensure that all authors are known to us, and that their rights are protected as well as ours. So there’s a signup process involved. In addition, the tech writers monitor all updates to the documentation via RSS feeds. We know what’s happening in the wiki, and we fix it if need be.
People who have not signed up for update rights can still take part in the ongoing quest for documentation perfection
and they do too, by adding comments directly onto the documentation pages. The wiki allows various levels of permissions, so we can give different permissions to anonymous users, signed up users, privileged users and company staff, for example.
For our situation, a strict review workflow with well-defined roles is not necessary and would tend to slow us down. But I agree with you that there are other situations where more control is required, such as where regulatory compliance is involved.
I’m guessing there are also a few shades of colour between the green of totally free collaboration and the blue of strictly defined review workflow.
Maybe it would be useful if a review tool allows flexibility in the number of roles (author, manager, reviewer, etc) and in the workflow steps/stages (draft, review, staging, published, etc), so that each organisation can tailor the tool to suit their needs. This is similar to code review procedures and tools. We develop a code review tool, and have found that some customers need a very simple workflow while others prefer multiple roles and stages.
It’s a great idea to have a collaborative review tool like LiveTechDocs available on the web, especially for XML-based documentation and other formats where live collaboration may be more difficult. This sounds equally as seductive as a wiki
I’m guessing you’ll get a lot of input on this post. It will be interesting to see what people have to say. Thank you so much for linking to my blog too!
Cheers
Sarah