Semantic MediaWiki - Documentation in the 21st century · Documents Find Edit Comment Broadcast...
Transcript of Semantic MediaWiki - Documentation in the 21st century · Documents Find Edit Comment Broadcast...
Documents Find Edit Comment Broadcast Requirements Summary
Semantic MediaWikiDocumentation in the 21st century
Will Swales1 Owen Kellie-Smith2
1Blue Actuarial
2Aviva
Life Conference, 2015
Documents Find Edit Comment Broadcast Requirements Summary
MediaWiki
Not new - made for WikipediaAccessed though a browserFree, libre, open-sourceExtended by Semantic MediaWiki
Documents Find Edit Comment Broadcast Requirements Summary
1 DocumentsSharing documents
2 FindBy title, content, editor
3 EditFlexibility, control, re-use
4 CommentTalk pages
5 BroadcastWhat’s new and who’s it from
6 RequirementsSkills, permissions
Documents Find Edit Comment Broadcast Requirements Summary
What we do all day (share documents)
find document create document
edit document comment on document
broadcast what’s new
Worker
Many of us share documents via email and Microsoft Office.
Documents Find Edit Comment Broadcast Requirements Summary
What we do all day (share documents)
find document create document
edit document comment on document
broadcast what’s new
Worker
Many of us share documents via email and Microsoft Office.
Documents Find Edit Comment Broadcast Requirements Summary
Semantic MediaWiki enables sharing
find document create document
edit document comment on document
broadcast what’s new
Worker
Documents Find Edit Comment Broadcast Requirements Summary
1 DocumentsSharing documents
2 FindBy title, content, editor
3 EditFlexibility, control, re-use
4 CommentTalk pages
5 BroadcastWhat’s new and who’s it from
6 RequirementsSkills, permissions
Documents Find Edit Comment Broadcast Requirements Summary
Finding documents
Do we have anything about subject-X?Where is that thing person-Y was working on a while ago?
Documents Find Edit Comment Broadcast Requirements Summary
Do we have anything about CPM?
Documents Find Edit Comment Broadcast Requirements Summary
Where is that thing Will was working on?
Documents Find Edit Comment Broadcast Requirements Summary
Finding related documents
What can put this in context?What links to this?
Documents Find Edit Comment Broadcast Requirements Summary
What links here
Documents Find Edit Comment Broadcast Requirements Summary
Context from category
Documents Find Edit Comment Broadcast Requirements Summary
Context from category
Documents Find Edit Comment Broadcast Requirements Summary
Renaming doesn’t break links
Documents Find Edit Comment Broadcast Requirements Summary
Compare features for finding
Windows Share-Point MediaWikiFind by string or user 7 4 4
Find by category 4 4 4
See links in 7 4 4
Rename safely 7 4 4
Recategorise safely 7 7 4
Documents Find Edit Comment Broadcast Requirements Summary
1 DocumentsSharing documents
2 FindBy title, content, editor
3 EditFlexibility, control, re-use
4 CommentTalk pages
5 BroadcastWhat’s new and who’s it from
6 RequirementsSkills, permissions
Documents Find Edit Comment Broadcast Requirements Summary
Editing documents
What version control is there?How much flexibility is allowed?How can flexibility be contained?
Documents Find Edit Comment Broadcast Requirements Summary
Contain flexibility by gatekeeping
Documents Find Edit Comment Broadcast Requirements Summary
Provide flexibility for UML
Documents Find Edit Comment Broadcast Requirements Summary
Editing documents
How is earlier work re-used?
Documents Find Edit Comment Broadcast Requirements Summary
Re-use glossary (tooltips)
Documents Find Edit Comment Broadcast Requirements Summary
Re-use glossary (tooltips)
Documents Find Edit Comment Broadcast Requirements Summary
Re-use glossary (tooltips)
Documents Find Edit Comment Broadcast Requirements Summary
Compare features for editing
Windows Share-Point MediaWikiForms 4 7 4
Gatekeeping 7 7 4
Glossary 7 7 4
Parsable external data 4 7 4
Templates 7 7 4
Documents Find Edit Comment Broadcast Requirements Summary
1 DocumentsSharing documents
2 FindBy title, content, editor
3 EditFlexibility, control, re-use
4 CommentTalk pages
5 BroadcastWhat’s new and who’s it from
6 RequirementsSkills, permissions
Documents Find Edit Comment Broadcast Requirements Summary
Commenting on documents
What do people think of this document?
Documents Find Edit Comment Broadcast Requirements Summary
Thoughts in the Talk pages
Documents Find Edit Comment Broadcast Requirements Summary
1 DocumentsSharing documents
2 FindBy title, content, editor
3 EditFlexibility, control, re-use
4 CommentTalk pages
5 BroadcastWhat’s new and who’s it from
6 RequirementsSkills, permissions
Documents Find Edit Comment Broadcast Requirements Summary
Alerting readers
What’s new?What’s been changed?What progress has been made?
Documents Find Edit Comment Broadcast Requirements Summary
What’s new over all
Documents Find Edit Comment Broadcast Requirements Summary
Who’s changed any document
Documents Find Edit Comment Broadcast Requirements Summary
What’s new in any document
Documents Find Edit Comment Broadcast Requirements Summary
Compare features for broadcasting
Windows Share-Point MediaWikiComments attached 7 7 4
Version control 7 4 4
Track changes (any pair) 7 4 4
Documents Find Edit Comment Broadcast Requirements Summary
Compare features
Windows Share-Point MediaWikiFind by string or user 7 4 4
Find by category 4 4 4
See links in 7 4 4
Rename with impunity 7 4 4
Recategorise with impunity 7 7 4
Forms 4 7 4
Gatekeeping 7 7 4
Glossary 7 7 4
Parsable external data 4 7 4
Templates 7 7 4
Comments attached 7 7 4
Version control 7 4 4
Track changes (any pair) 7 4 4
Documents Find Edit Comment Broadcast Requirements Summary
1 DocumentsSharing documents
2 FindBy title, content, editor
3 EditFlexibility, control, re-use
4 CommentTalk pages
5 BroadcastWhat’s new and who’s it from
6 RequirementsSkills, permissions
Documents Find Edit Comment Broadcast Requirements Summary
Skills
Writing pages (like writing in Word or entering data inExcel).Writing templates (like writing Excel formulae).Writing modules (like writing VBA).
Configuring server (if setting up your own). Needsfamiliarity with PHP & e.g. Apache.
Documents Find Edit Comment Broadcast Requirements Summary
Skills
Writing pages (like writing in Word or entering data inExcel).Writing templates (like writing Excel formulae).Writing modules (like writing VBA).Configuring server (if setting up your own). Needsfamiliarity with PHP & e.g. Apache.
Documents Find Edit Comment Broadcast Requirements Summary
Resources
Help page at e.g. en.wikipedia.org/wiki/Help:Contentsmediawiki.orgWorking with Mediawiki by Yaron Koren [1]semantic-mediawiki.orgwebmasters.stackexchange.com
Documents Find Edit Comment Broadcast Requirements Summary
To set up your own wiki
External (public information):15 mins on e.g. openshift.com.Example (with cloning instructions) atmediawiki-treaties.rhcloud.com/wiki.
In-house (confidential information):Agreement from IT Security, IT Architecture, Procurementetc. 27 contributors (that we know about). Thank you!
Documents Find Edit Comment Broadcast Requirements Summary
Summary
Semantic MediaWiki - find everything in one place.
Appendix
Beamer
Slides were made with Beamer[2] using the Frankfurttheme.Screen shots are from modelling.friendslife.co.uk at 1600 x900 resolution at 250% or 400% magnification.Text aims to follow Lucidity principles[3].
Appendix
For Further Reading
Yaron Koren.Working with MediaWiki.WikiWorks Press, 2012.
Till Tantau.User Guide to the Beamer Class.
Michael McIntyreLucidity principles in brief.www.atm.damtp.cam.ac.uk/people/mem/lucidity-in-brief.