using and customizing mediawiki for documentation … · zmediawiki, hosted by comet zcategories...
TRANSCRIPT
![Page 1: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/1.jpg)
© Comet Computer GmbH 1
Using and Customizing MediaWikiUsing and Customizing MediaWikifor Documentation Projectsfor Documentation Projects
Heikki Komulainentcworld Roadshow, May 25, 2009, Helsinki
![Page 2: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/2.jpg)
© Comet Computer GmbH 2
Company Company PresentationPresentation
![Page 3: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/3.jpg)
© Comet Computer GmbH 3
TheThe Comet GroupComet Group
Comet Computer GmbH Comet Computer GmbH & &
Comet Communication GmbHComet Communication GmbH
Munich, Berlin, Karlsruhe, Berg
![Page 4: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/4.jpg)
© 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
![Page 5: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/5.jpg)
© Comet Computer GmbH 5
OurOur ServicesServices
ConsultingProject managementContent creationProgrammingSystem configurationLocalizationTraining
Full service for technical communication
![Page 6: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/6.jpg)
© Comet Computer GmbH 6
OurOur ProductsProducts
Information architectureAll types of manualsOnline help systemsReady-to-use documentation environmentsTraining materialE-Learning coursesWeb sites
![Page 7: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/7.jpg)
© 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.
![Page 8: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/8.jpg)
© 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):
![Page 9: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/9.jpg)
© Comet Computer GmbH 9
OurOur PartnersPartners
Comet is sales and training partner of renowned vendors
![Page 10: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/10.jpg)
© Comet Computer GmbH 10
Comet Comet IsIs an an ActiveActive MemberMember ofof
![Page 11: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/11.jpg)
© 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.
![Page 12: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/12.jpg)
© Comet Computer GmbH 12
A quickA quick overviewoverview ofof Wiki Wiki
![Page 13: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/13.jpg)
© 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)
![Page 14: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/14.jpg)
© Comet Computer GmbH 14
What Is a What Is a WikiWiki??EDIT
![Page 15: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/15.jpg)
© 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
![Page 16: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/16.jpg)
© Comet Computer GmbH 16
Productive Uses for a Productive Uses for a WikiWiki
Collaborative writingCommunity software Simplified content management systemKnowledge managementGroupware
![Page 17: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/17.jpg)
© Comet Computer GmbH 17
Productive Uses for a Productive Uses for a WikiWiki
CoordinationGuidelinesBrainstorming
Highly dynamic processes InputReview Project management
CollaborationGlossariesArticle collections
![Page 18: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/18.jpg)
© Comet Computer GmbH 18
RealReal--Life Example:Life Example:
A Glossary Built with MediaWikiA Glossary Built with MediaWiki
![Page 19: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/19.jpg)
© Comet Computer GmbH 19
PurposePurpose
Support collaborative work of a distributed documentation team
Team members working at different locations(different companies, different countries)
![Page 20: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/20.jpg)
© Comet Computer GmbH 20
ChallengesChallenges
Enabling access for all team members
Content classificationSeparating glossary and project management
Export to Author-itcontent management system
![Page 21: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/21.jpg)
© 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
![Page 22: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/22.jpg)
© 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
![Page 23: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/23.jpg)
© Comet Computer GmbH 23
SolutionsSolutionsContentContent classificationclassification
Built-in system for categorizationSemantic MediaWiki (SMW) extensionfor assigning attributes
Enables semantic searchAllows fine-grained export
![Page 24: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/24.jpg)
© Comet Computer GmbH 24
SolutionsSolutionsTemplatesTemplates
Ensure consistent layout of articlesMake it easier to start writingSpeed up the writing process
![Page 25: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/25.jpg)
© Comet Computer GmbH 25
SolutionsSolutionsExportExport
Built-in XML export lacks formattingCustom-made export to MS-Word
![Page 26: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/26.jpg)
© Comet Computer GmbH 26
ResultsResults
Over 700 terms and abbreviations40 status reports and many meeting reportsHappy writersHappy customerWiki is still in active use
![Page 27: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/27.jpg)
© Comet Computer GmbH 27
RealReal--Life Example:Life Example:
Collaborative Writing of an Collaborative Writing of an Accreditation ProposalAccreditation Proposal
![Page 28: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/28.jpg)
© 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
![Page 29: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/29.jpg)
© Comet Computer GmbH 29
ChallengesChallenges
Distributed teamDifficulties finding time for common meetings30 people working on few documentsWiki skeptics
![Page 30: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/30.jpg)
© Comet Computer GmbH 30
SolutionSolution
MediaWiki, hosted by CometCategories predefined Initial content addedSome parts of the content modularized Exported with a “bot”
![Page 31: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/31.jpg)
© Comet Computer GmbH 31
ResultsResults
Proposals written in 3 months instead of 2 to 3 yearsHigh quality
![Page 32: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/32.jpg)
© 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!
![Page 33: Using and Customizing MediaWiki for Documentation … · zMediaWiki, hosted by Comet zCategories predefined zInitial content added zSome parts of the content modularized zExported](https://reader031.vdocuments.mx/reader031/viewer/2022013016/5bb97edc09d3f2da618bed38/html5/thumbnails/33.jpg)
© Comet Computer GmbH 33
QuestionsQuestions??
www.comet.dewww.comet.de