Wednesday Feb 07, 2007
In my personal weblog I wrote a piece about My Methodolgy of writing Documentation with Wikis. Needless to say that this is the methodology we are using internally at Mindquarry for documenting the Mindquarry Collaboration Server.
- I plan and organize the documentation project using an issue tracking system and create tasks for every step in the documentation process
- I 'harvest' product development Wikis for information about the software I am documenting. This is the first use of Wikis - a source of information
- I create a content outline of the planned document in the Wiki and invite other team members to comment and correct the content outline. The Wiki here is a space for distributed brain-storming.
- I write the document using DocBook-XML, WYSIWYG-XML-editors and share the in-progress document and illustrations using a version control system. As I am using DocBook and Mindquarry's file sharing, concurrent editing of modular documents is easy.
- Reviewers and copy-editor use the issue tracking system to create comments and remarks to the documentation.
- After releasing the document, the issue tracking system is used to track comments and suggestions for improvements. As the Wiki keeps evolving I have a good starting point for a second revison of the document.
Also needless to say that the Wiki, issue tracking system for task management and file sharing server are all integrated in the Mindquarry Collaboration Server.
Posted at 11:53AM Feb 07, 2007 (Permalink)
by Lars Trieloff with tags
filesharing
mindquarry
tasks
techdoc
tips
wiki
|
Share This Link
Comments:
Post a Comment:
Comments are closed for this entry.
