using and customizing mediawiki for documentation … · zmediawiki, hosted by comet zcategories...

© Comet Computer GmbH 1

Using and Customizing MediaWikiUsing and Customizing MediaWikifor Documentation Projectsfor Documentation Projects

Heikki Komulainentcworld Roadshow, May 25, 2009, Helsinki


Company Company PresentationPresentation


TheThe Comet GroupComet Group

Comet Computer GmbH Comet Computer GmbH & &

Comet Communication GmbHComet Communication GmbH

Munich, Berlin, Karlsruhe, Berg


TechnicalCommunication

Leading provider of technical documentation in GermanyFounded 1987Currently with 75 employeesRenowned, long-term clientsWinner of numerous national and international awards

TheThe Comet GroupComet Group

Software Development


OurOur ServicesServices

ConsultingProject managementContent creationProgrammingSystem configurationLocalizationTraining

Full service for technical communication


OurOur ProductsProducts

Information architectureAll types of manualsOnline help systemsReady-to-use documentation environmentsTraining materialE-Learning coursesWeb sites


Comet Comet IsIs a Global a Global PlayerPlayer

We have customer relationships with companies in:Austria, China, Germany, Finland, Switzerland, USA

We have in-house localization departments for:German, English, French, Japanese, Chinese

We work in international teams.


OurOur CustomersCustomers

Several hundred international companies trust usPublic authorities, banks, insurances, companiesof all industrial sectors

Some major clients (visit www.comet.de for more):


OurOur PartnersPartners

Comet is sales and training partner of renowned vendors


Comet Comet IsIs an an ActiveActive MemberMember ofof


OurOur SkillsSkills

Graphic and Web designers

Documentation experts

Liberal arts academics

IT experts

Comet TeamScientists

Translators

Project managers

Our combination of IT and language skills sets standards.


A quickA quick overviewoverview ofof Wiki Wiki


What Is a What Is a WikiWiki??

A wiki is a collection of Web pages designed to enable anyone with access to contribute or modify content, using a simplified markup language.Source: Wikipedia (http://en.wikipedia.org/wiki/Wiki)


What Is a What Is a WikiWiki??EDIT


WikiWiki SoftwareSoftware

Over 200 wiki enginesOpen source and commercialWiki functionality in other types of software

More information:

http://www.wikimatrix.org/http://en.wikipedia.org/wiki/Comparison_of_wiki_software


Productive Uses for a Productive Uses for a WikiWiki

Collaborative writingCommunity software Simplified content management systemKnowledge managementGroupware


Productive Uses for a Productive Uses for a WikiWiki

CoordinationGuidelinesBrainstorming

Highly dynamic processes InputReview Project management

CollaborationGlossariesArticle collections


RealReal--Life Example:Life Example:

A Glossary Built with MediaWikiA Glossary Built with MediaWiki


PurposePurpose

Support collaborative work of a distributed documentation team

Team members working at different locations(different companies, different countries)


ChallengesChallenges

Enabling access for all team members

Content classificationSeparating glossary and project management

Export to Author-itcontent management system


Why MediaWiki?Why MediaWiki?

Highly suitable for glossariesEasy to learnEasy to set upSolves some of the challenges (“out-of-the-box”)Fairly easy to extend“Soft security” suitable for the intended use


SolutionsSolutionsSeparation of different content types Separation of different content types

Built-in namespaces“Main” namespace for actual content“Project” namespace for project organization


SolutionsSolutionsContentContent classificationclassification

Built-in system for categorizationSemantic MediaWiki (SMW) extensionfor assigning attributes

Enables semantic searchAllows fine-grained export


SolutionsSolutionsTemplatesTemplates

Ensure consistent layout of articlesMake it easier to start writingSpeed up the writing process


SolutionsSolutionsExportExport

Built-in XML export lacks formattingCustom-made export to MS-Word


ResultsResults

Over 700 terms and abbreviations40 status reports and many meeting reportsHappy writersHappy customerWiki is still in active use


RealReal--Life Example:Life Example:

Collaborative Writing of an Collaborative Writing of an Accreditation ProposalAccreditation Proposal


PurposePurpose

Support a team of university staff in writing accreditation proposals

Collecting materialApproving material

Export proposals in MS Word formatShorten the time needed for the accreditation process


ChallengesChallenges

Distributed teamDifficulties finding time for common meetings30 people working on few documentsWiki skeptics


SolutionSolution

MediaWiki, hosted by CometCategories predefined Initial content addedSome parts of the content modularized Exported with a “bot”


ResultsResults

Proposals written in 3 months instead of 2 to 3 yearsHigh quality


ConclusionsConclusions

Save timeBetter quality

Even more time savedLow costs or even freeNot only for limited budgets but also for limited schedule!


QuestionsQuestions??

www.comet.dewww.comet.de

using and customizing mediawiki for documentation … · zmediawiki, hosted by comet zcategories...

Documents