devops documentation: manage documentation in a shared ownership environment
TRANSCRIPT
@docdepartment
DevOps DocumentationManaging documentation in a shared ownership
environment
@docdepartment@docdepartment
@docdepartment@docdepartment
increase in revenue from product
collaborations
15%
www.atkearney.com/innovation/collaborative-innovation
@docdepartment@docdepartment
collaboration
@docdepartment@docdepartment
find teammates who do
something you can’t
@docdepartment@docdepartment
@docdepartment@docdepartment
“social” business uses social
technology to foster collaboration
IBMSocialStudy, 2014
74%
@docdepartment@docdepartment
strategy first
technology follows
@docdepartment@docdepartment
@docdepartment@docdepartment
@docdepartment@docdepartment
create and maintain
documentation required by
product or service produced as
result of collaboration
@docdepartment@docdepartment
material that provides
official information
or evidence,
or material that serves as a
record
@docdepartment@docdepartment
tech comms framework
is
content strategy
@docdepartment@docdepartment
content strategy
content
design
process
standards
Information / content model
style guide | DITA | DocBook
CSS | template
agile | waterfall | kanban
PDF | xliff | SCORM
@docdepartment@docdepartment
waterfall
spiral
v-shaped
iterative
open source
Serial (>)Develop > Document > Translate
Parallel ( )Develop
Document
Translate
Collective ()Develop
Document
Translate
Virtual Collaborative Writing in the Workplace, Hewett & Robidoux
@docdepartment@docdepartment
monarchy
hierarchy
democracy
consensus
anarchy
scale pace qual.
Virtual Collaborative Writing in the Workplace, Hewett & Robidoux
@docdepartment@docdepartment
content strategy
content
design
process
standards
In. Ar TC
SME
>
TC >
UX
UI >
TC
@docdepartment@docdepartment
collaboration between
development and operations to
create, deliver and operate
a product or service
Anne Gentle, 2009
@docdepartment@docdepartment
2 weeks 2 weeks
Service Desk
NOC
Docs [email protected]
DevOps
x x2 weeks
Development Operations
@docdepartment@docdepartment
documentation as a
conversation
Anne Gentle, 2009
@docdepartment@docdepartment
o framework
o synchronous comms
o transparent & open
o collaborative
@docdepartment@docdepartment
content strategy
tools
design
process
standards
TC >
TC
PO
TC TC
Dev Ops
@docdepartment@docdepartment
content
troubleshooting
product
system arch.
system design
3rd party
Dev Ops
TC
Ops
Dev
Ops
DevO
ps
@docdepartment@docdepartment
Development Operations
Service Desk
NOC
K’ Base
DevOps
2 weeks
documentation as a conversation
@docdepartment@docdepartment
o deconstruct documentation
o create framework
o manage each piece
appropriately
@docdepartment@docdepartment