E-mail
Get that into the wiki! - using wiki to easily document your systems
Greg Warner
Abstract
A wiki is the simplest and quickest way to document systems as well as creating a repository of tacit information.
Providing a wiki to the userbase allows the users to contribute to the overall documentation of the system as well as providing feedback to the implementation team.
This paper will provide a real-life example of a wiki used to document with intricate detail a complex environment and will highlight some of the considerations for your environment.
Traditional documentation methods had no contextual relationship with the system and can quickly become out of date when maintenance releases are applied.
The wiki in this talk currently contains static data in the form of articles, but also executes scripts to report the status of the production systems and graphs these within the appropriate articles.
The use of relationships and categorisation of wiki articles also allows users of the system to link their articles to those in related fields so that when modifications are being made to system parameters, it is now possible to see other areas where the changes may have an impact.
Presenter Biography
Greg Warner is a business analyst with BAE Systems Australia with a Biomedical Science degree from the University of Adelaide. Greg has been working as part of the implementation team for an enterprise product data management system for projects such as the joint strike fighter. Previously Greg had worked at the University of South Australia as s senior systems administrator where documenting systems for student use was problematic. The answer was to empower the user base to document the system using wiki.Greg is a wiki evangelist.