Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories...

Post on 07-Oct-2018

220 views 0 download

Transcript of 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

© Comet Computer GmbH 2

Company Company PresentationPresentation

© Comet Computer GmbH 3

TheThe Comet GroupComet Group

Comet Computer GmbH Comet Computer GmbH & &

Comet Communication GmbHComet Communication GmbH

Munich, Berlin, Karlsruhe, Berg

© Comet Computer GmbH 4

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

© Comet Computer GmbH 5

OurOur ServicesServices

ConsultingProject managementContent creationProgrammingSystem configurationLocalizationTraining

Full service for technical communication

© Comet Computer GmbH 6

OurOur ProductsProducts

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

© Comet Computer GmbH 7

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.

© Comet Computer GmbH 8

OurOur CustomersCustomers

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

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

© Comet Computer GmbH 9

OurOur PartnersPartners

Comet is sales and training partner of renowned vendors

© Comet Computer GmbH 10

Comet Comet IsIs an an ActiveActive MemberMember ofof

© Comet Computer GmbH 11

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.

© Comet Computer GmbH 12

A quickA quick overviewoverview ofof Wiki Wiki

© Comet Computer GmbH 13

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)

© Comet Computer GmbH 14

What Is a What Is a WikiWiki??EDIT

© Comet Computer GmbH 15

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

© Comet Computer GmbH 16

Productive Uses for a Productive Uses for a WikiWiki

Collaborative writingCommunity software Simplified content management systemKnowledge managementGroupware

© Comet Computer GmbH 17

Productive Uses for a Productive Uses for a WikiWiki

CoordinationGuidelinesBrainstorming

Highly dynamic processes InputReview Project management

CollaborationGlossariesArticle collections

© Comet Computer GmbH 18

RealReal--Life Example:Life Example:

A Glossary Built with MediaWikiA Glossary Built with MediaWiki

© Comet Computer GmbH 19

PurposePurpose

Support collaborative work of a distributed documentation team

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

© Comet Computer GmbH 20

ChallengesChallenges

Enabling access for all team members

Content classificationSeparating glossary and project management

Export to Author-itcontent management system

© Comet Computer GmbH 21

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

© Comet Computer GmbH 22

SolutionsSolutionsSeparation of different content types Separation of different content types

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

© Comet Computer GmbH 23

SolutionsSolutionsContentContent classificationclassification

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

Enables semantic searchAllows fine-grained export

© Comet Computer GmbH 24

SolutionsSolutionsTemplatesTemplates

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

© Comet Computer GmbH 25

SolutionsSolutionsExportExport

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

© Comet Computer GmbH 26

ResultsResults

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

© Comet Computer GmbH 27

RealReal--Life Example:Life Example:

Collaborative Writing of an Collaborative Writing of an Accreditation ProposalAccreditation Proposal

© Comet Computer GmbH 28

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

© Comet Computer GmbH 29

ChallengesChallenges

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

© Comet Computer GmbH 30

SolutionSolution

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

© Comet Computer GmbH 31

ResultsResults

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

© Comet Computer GmbH 32

ConclusionsConclusions

Save timeBetter quality

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

© Comet Computer GmbH 33

QuestionsQuestions??

www.comet.dewww.comet.de