Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
Workflow for documentation in Open Source projects
Search
Ronny Trommer
February 15, 2016
Technology
0
83
Workflow for documentation in Open Source projects
Talk given at Chemnitzer Linux-Tage 2015.
Ronny Trommer
February 15, 2016
Tweet
Share
More Decks by Ronny Trommer
See All by Ronny Trommer
Docker - Hello Ground!
indigo
0
53
OSMC 2017 - Another year with OpenNMS
indigo
1
280
Run Your Own Fucking Infrastructure
indigo
0
160
Introduction to OpenNMS
indigo
0
210
We don't need no documentation
indigo
2
110
OpenNMS meets Grafana
indigo
0
560
VMware and OpenNMS in Real World
indigo
0
160
Make the net work
indigo
0
49
Monitoring Virtualization Infrastructure with OpenNMS
indigo
1
480
Other Decks in Technology
See All in Technology
EM完全に理解した と思ったけど、 やっぱり何も分からなかった話 / EM Night Fukuoka #1
hirutas
0
280
AOAI をきっかけに 社内の Azure 管理を見直した話
recruitengineers
PRO
1
450
IPUT App Dev. Co. -Overview 2024/4
iputapp
0
120
AWS学習者向けにAzureの解説スライドを作成した話
handy
3
190
今日からできる!簡単 .NET 高速化 Tips -2024 edition-
xin9le
7
3.6k
AWSに詳しくない人でも始められるコスト最適化ガイド
yuhta28
2
280
いつか使うかも貯金してたらめちゃめちゃ機能が増えてた話
riyaamemiya
0
610
require(ESM)とECMAScript仕様
uhyo
4
950
ルーターでプレゼンする
puhitaku
1
3.2k
20分で完全に理解するGrafanaダッシュボード
hamadakoji
5
890
Babylon.jsと色々なものを組み合わせる:ブラウザのAPIやガジェットや2D描画ライブラリなど / Babylon.js 勉強会 vol.3
you
PRO
0
160
Azure Container Apps + Bicep 〜 こんな感じで運用しています
kaz29
3
620
Featured
See All Featured
Adopting Sorbet at Scale
ufuk
69
8.6k
Mobile First: as difficult as doing things right
swwweet
217
8.6k
Creatively Recalculating Your Daily Design Routine
revolveconf
211
11k
Navigating Team Friction
lara
179
13k
Code Review Best Practice
trishagee
56
15k
The Brand Is Dead. Long Live the Brand.
mthomps
49
29k
Pencils Down: Stop Designing & Start Developing
hursman
117
11k
The Cult of Friendly URLs
andyhume
74
5.7k
Testing 201, or: Great Expectations
jmmastey
29
6.4k
A better future with KSS
kneath
231
16k
What's new in Ruby 2.0
geeforr
337
31k
Web Components: a chance to create the future
zenorocha
306
41k
Transcript
Workflow for documentation in Open Source projects Ronny Trommer https://github.com/indigo423/clt2015
Research project enRZet GPL freelancer OFE e.V.
Motivation started as OpenNMS user Experienced the lack of docs
Found friends wrote a book 2nd Edition another year?
Source code our documentation is! http://goo.gl/cIYrF1
None
http://www.strangedangers.com/content/item/155295.html
http://www.fosterandpartners.com/projects/millau-viaduct/
http://whenonearth.net/cross-moses-bridge-fort-de-roovere-netherlands/
http://whenonearth.net/cross-moses-bridge-fort-de-roovere-netherlands/
Source code is the what, not the why. https://scalibq.wordpress.com/2011/07/06/source-code-is-not-documentation/
source code == documentation http://goo.gl/7M4YeZ
http://goo.gl/4qw2rF
Wrong understanding of documentation http://goo.gl/4qw2rF
Wrong understanding of documentation http://goo.gl/4qw2rF Write docs to have docs.
Why? Empower people to use your software in the most
efficient and right way. http://goo.gl/7M4YeZ
But How? shared understanding! http://goo.gl/7M4YeZ
Outdated It’s just wrong Explain stuff you already know Does
not exist Problems with docs?
Outdated It’s just wrong Explain stuff you already know Does
not exist Informiert den Techniker! Problems with docs?
Wiki Docbook OpenNMS Book Let’s see … White paper
Wiki Docbook OpenNMS Book Let’s see … White paper !!
!!
• Integration in development • Define a workflow for contribution
• Allow tracking of documentation issues • Integrate in review process • Add docs to your acceptance criteria • Iteration, Iteration, Iteration Treat docs as you treat source code
+ +
Link by JIRA issue number Driven by commits against branch
None
http://xkcd.com/1285 Review for docs • What is written in monospace
• When use italic • When use bold • Table formatting —> easier to read • JIRA links and JIRA number Formal
http://xkcd.com/1285 Review for docs • Native speaker, language, grammar •
Complete • Useful • Iteration on Pull Request Content
http://wiki.opennms.org/
• What is really version control relevant • fast vs.
slow changing • Strong related to OpenNMS version • Slice by target group - User vs. Developer • Search for patterns and components Divide and Conquer
git Wiki 3rd party configs Tutorials Integrations Architecture Concepts Features
Dashboard Dashlet 1 … Dashlet n Monitors for service tests
Monitor 1 … Monitor n Data collection Collector 1 … Collector n
None
None
None
None
Ascii for the win Low barrier to edit Version controlled
Markdown Some evaluation
None
Maven support Allows multiple outputs Features GitHub support Themes for
PDF and HTML
None
None
None
OS independent Graph UML + PNG Free of charge …
even commercial
OS independent Graph UML + PNG Free of charge …
even commercial redistribution and use in automation
GitHub AsciiDoc JIRA establish some rules … yEd
http://xkcd.com/1285
http://xkcd.com/1285 Easier diffs Identify too long sentences Sentence beginning Less
conflicts
None
None
Credits: ! Neo4j for AsciiDoc format conventions Spring for pointing
us to AsciiDoc AsciiDoctor for building the cool tool chain Friends and community members for discussions