26
@docdepartment DevOps Documentation Managing documentation in a shared ownership environment

DevOps documentation: Manage documentation in a shared ownership environment

Embed Size (px)

Citation preview

Page 1: DevOps documentation: Manage documentation in a shared ownership environment

@docdepartment

DevOps DocumentationManaging documentation in a shared ownership

environment

Page 2: DevOps documentation: Manage documentation in a shared ownership environment

@docdepartment@docdepartment

Page 3: DevOps documentation: Manage documentation in a shared ownership environment

@docdepartment@docdepartment

increase in revenue from product

collaborations

15%

www.atkearney.com/innovation/collaborative-innovation

Page 4: DevOps documentation: Manage documentation in a shared ownership environment

@docdepartment@docdepartment

collaboration

Page 5: DevOps documentation: Manage documentation in a shared ownership environment

@docdepartment@docdepartment

find teammates who do

something you can’t

Page 6: DevOps documentation: Manage documentation in a shared ownership environment

@docdepartment@docdepartment

Page 7: DevOps documentation: Manage documentation in a shared ownership environment

@docdepartment@docdepartment

“social” business uses social

technology to foster collaboration

IBMSocialStudy, 2014

74%

Page 8: DevOps documentation: Manage documentation in a shared ownership environment

@docdepartment@docdepartment

strategy first

technology follows

Page 9: DevOps documentation: Manage documentation in a shared ownership environment

@docdepartment@docdepartment

Page 10: DevOps documentation: Manage documentation in a shared ownership environment

@docdepartment@docdepartment

Page 11: DevOps documentation: Manage documentation in a shared ownership environment

@docdepartment@docdepartment

create and maintain

documentation required by

product or service produced as

result of collaboration

Page 12: DevOps documentation: Manage documentation in a shared ownership environment

@docdepartment@docdepartment

material that provides

official information

or evidence,

or material that serves as a

record

Page 13: DevOps documentation: Manage documentation in a shared ownership environment

@docdepartment@docdepartment

tech comms framework

is

content strategy

Page 14: DevOps documentation: Manage documentation in a shared ownership environment

@docdepartment@docdepartment

content strategy

content

design

process

standards

Information / content model

style guide | DITA | DocBook

CSS | template

agile | waterfall | kanban

PDF | xliff | SCORM

Page 15: DevOps documentation: Manage documentation in a shared ownership environment

@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

Page 16: DevOps documentation: Manage documentation in a shared ownership environment

@docdepartment@docdepartment

monarchy

hierarchy

democracy

consensus

anarchy

scale pace qual.

Virtual Collaborative Writing in the Workplace, Hewett & Robidoux

Page 17: DevOps documentation: Manage documentation in a shared ownership environment

@docdepartment@docdepartment

content strategy

content

design

process

standards

In. Ar TC

SME

>

TC >

UX

UI >

TC

Page 18: DevOps documentation: Manage documentation in a shared ownership environment

@docdepartment@docdepartment

collaboration between

development and operations to

create, deliver and operate

a product or service

Anne Gentle, 2009

Page 19: DevOps documentation: Manage documentation in a shared ownership environment

@docdepartment@docdepartment

2 weeks 2 weeks

Service Desk

NOC

Docs [email protected]

DevOps

x x2 weeks

Development Operations

Page 20: DevOps documentation: Manage documentation in a shared ownership environment

@docdepartment@docdepartment

documentation as a

conversation

Anne Gentle, 2009

Page 21: DevOps documentation: Manage documentation in a shared ownership environment

@docdepartment@docdepartment

o framework

o synchronous comms

o transparent & open

o collaborative

Page 22: DevOps documentation: Manage documentation in a shared ownership environment

@docdepartment@docdepartment

content strategy

tools

design

process

standards

TC >

TC

PO

TC TC

Dev Ops

Page 23: DevOps documentation: Manage documentation in a shared ownership environment

@docdepartment@docdepartment

content

troubleshooting

product

system arch.

system design

3rd party

Dev Ops

TC

Ops

Dev

Ops

DevO

ps

Page 24: DevOps documentation: Manage documentation in a shared ownership environment

@docdepartment@docdepartment

Development Operations

Service Desk

NOC

K’ Base

DevOps

2 weeks

documentation as a conversation

Page 25: DevOps documentation: Manage documentation in a shared ownership environment

@docdepartment@docdepartment

o deconstruct documentation

o create framework

o manage each piece

appropriately

Page 26: DevOps documentation: Manage documentation in a shared ownership environment

@docdepartment@docdepartment