mediawiki as a software documentation cms
TRANSCRIPT
![Page 1: Mediawiki as a software documentation CMS](https://reader038.vdocuments.net/reader038/viewer/2022110218/58ce7d6a1a28ab210a8b4ceb/html5/thumbnails/1.jpg)
1© 2016, Genesys Telecommunications Laboratories, Inc. All rights reserved.
MEDIAWIKI AS A SOFTWARE DOCUMENTATION CMS
Juan Lara <[email protected]>, @JRLtechwritingBarry Grenon <[email protected]>
![Page 2: Mediawiki as a software documentation CMS](https://reader038.vdocuments.net/reader038/viewer/2022110218/58ce7d6a1a28ab210a8b4ceb/html5/thumbnails/2.jpg)
2
WHO IS GENESYS?
Biggest software company in the valley that no one has ever heard of.*
*Thing Genesys people say at cocktail parties
![Page 3: Mediawiki as a software documentation CMS](https://reader038.vdocuments.net/reader038/viewer/2022110218/58ce7d6a1a28ab210a8b4ceb/html5/thumbnails/3.jpg)
3
STARTING POINT• FrameMaker -> PDFs• RoboHelp -> CHMs
![Page 4: Mediawiki as a software documentation CMS](https://reader038.vdocuments.net/reader038/viewer/2022110218/58ce7d6a1a28ab210a8b4ceb/html5/thumbnails/4.jpg)
4
STARTING POINT• FrameMaker -> PDFs -> Updated only twice a year • RoboHelp -> CHMs -> Must be ready one month before software release
![Page 5: Mediawiki as a software documentation CMS](https://reader038.vdocuments.net/reader038/viewer/2022110218/58ce7d6a1a28ab210a8b4ceb/html5/thumbnails/5.jpg)
5
No budget? Try open source
![Page 6: Mediawiki as a software documentation CMS](https://reader038.vdocuments.net/reader038/viewer/2022110218/58ce7d6a1a28ab210a8b4ceb/html5/thumbnails/6.jpg)
6
PILOT PROJECT
![Page 7: Mediawiki as a software documentation CMS](https://reader038.vdocuments.net/reader038/viewer/2022110218/58ce7d6a1a28ab210a8b4ceb/html5/thumbnails/7.jpg)
7
ENTER PONYDOCShttps://github.com/splunk/ponydocs
Support for:
• Products• Manuals• Table of Contents• Versioning• User Permissions
![Page 8: Mediawiki as a software documentation CMS](https://reader038.vdocuments.net/reader038/viewer/2022110218/58ce7d6a1a28ab210a8b4ceb/html5/thumbnails/8.jpg)
8
GENESYS DOCUMENTATION
![Page 9: Mediawiki as a software documentation CMS](https://reader038.vdocuments.net/reader038/viewer/2022110218/58ce7d6a1a28ab210a8b4ceb/html5/thumbnails/9.jpg)
9
PRODUCTS
[[Documentation:ListAllProducts]]
![Page 10: Mediawiki as a software documentation CMS](https://reader038.vdocuments.net/reader038/viewer/2022110218/58ce7d6a1a28ab210a8b4ceb/html5/thumbnails/10.jpg)
10
MANUALS
[[Documentation:GCB:Manuals]]
![Page 11: Mediawiki as a software documentation CMS](https://reader038.vdocuments.net/reader038/viewer/2022110218/58ce7d6a1a28ab210a8b4ceb/html5/thumbnails/11.jpg)
11
TABLE OF CONTENTS[[Documentation:GCB:DeploymentTOC8.5.0]]
![Page 12: Mediawiki as a software documentation CMS](https://reader038.vdocuments.net/reader038/viewer/2022110218/58ce7d6a1a28ab210a8b4ceb/html5/thumbnails/12.jpg)
12
VERSIONING AND PERMISSIONS
[[Documentation:GCB:Versions]]
![Page 13: Mediawiki as a software documentation CMS](https://reader038.vdocuments.net/reader038/viewer/2022110218/58ce7d6a1a28ab210a8b4ceb/html5/thumbnails/13.jpg)
13
NEXT EVOLUTION: STRUCTURED CONTENT
![Page 14: Mediawiki as a software documentation CMS](https://reader038.vdocuments.net/reader038/viewer/2022110218/58ce7d6a1a28ab210a8b4ceb/html5/thumbnails/14.jpg)
14
STRUCTURED CONTENT - SIMPLE◉ First, simplest structured content project (DPL): Integrated Glossary
Glossary Front page Individual Glossary Term page
Glossary popup in docs page
![Page 15: Mediawiki as a software documentation CMS](https://reader038.vdocuments.net/reader038/viewer/2022110218/58ce7d6a1a28ab210a8b4ceb/html5/thumbnails/15.jpg)
15
STRUCTURED CONTENT – GETTING COMPLICATED
◉ Genesys products are highly customizable – > 10 000 configuration options in Genesys – stored, with descriptions, in XML files (10 756, according to Cargo)
◉ Process:● Script writes content from XML files to discrete wiki pages using MW API.● Discrete pages live in a dedicated, internal-only namespace.● Content saved in structured template format.● Content is pulled into public pages in various ways: portal lists, query form, popups
embedded in regular articles
![Page 16: Mediawiki as a software documentation CMS](https://reader038.vdocuments.net/reader038/viewer/2022110218/58ce7d6a1a28ab210a8b4ceb/html5/thumbnails/16.jpg)
16
CONFIGURATION OPTIONS
![Page 17: Mediawiki as a software documentation CMS](https://reader038.vdocuments.net/reader038/viewer/2022110218/58ce7d6a1a28ab210a8b4ceb/html5/thumbnails/17.jpg)
17
SUPPORTED OPERATING ENVIRONMENT INFO
![Page 18: Mediawiki as a software documentation CMS](https://reader038.vdocuments.net/reader038/viewer/2022110218/58ce7d6a1a28ab210a8b4ceb/html5/thumbnails/18.jpg)
18
CARGO DESIGN PATTERN
◉ Design content structure. Build cargo database.◉ Design an input interface with PageForms.◉ Create templates and queries for data consumption (as many flavors as
you like).
![Page 19: Mediawiki as a software documentation CMS](https://reader038.vdocuments.net/reader038/viewer/2022110218/58ce7d6a1a28ab210a8b4ceb/html5/thumbnails/19.jpg)
19
CARGO DESIGN PATTERN
Product Managers
(Simple Data Input)
Engineers(Complex Data Consumption)
Content Architecture Team
![Page 20: Mediawiki as a software documentation CMS](https://reader038.vdocuments.net/reader038/viewer/2022110218/58ce7d6a1a28ab210a8b4ceb/html5/thumbnails/20.jpg)
20
WHERE WE WANT TO GO◉ Refactor Ponydocs to use Cargo.◉ Create strict templates & forms for page types.◉ Gather controlled metadata whenever a page is created.◉ Leverage metadata for rich subject affinity linking.
![Page 21: Mediawiki as a software documentation CMS](https://reader038.vdocuments.net/reader038/viewer/2022110218/58ce7d6a1a28ab210a8b4ceb/html5/thumbnails/21.jpg)
21
WHERE WE WANT TO GO◉ Refactor Ponydocs to use Cargo.◉ Create strict templates & forms for page types.◉ Gather controlled metadata whenever a page is created.◉ Leverage metadata for rich subject affinity linking.
+ Ponydocs + -> EPPO CMS(Every Page is Page One)