SlideShare uma empresa Scribd logo
1 de 51
H O W C A N D O C U M E N T A T I O N
B E C O M E I N H E R E N T L Y A G I L E ?
J E N N I F E R R I G G I N S @ J K R I G G I N S
# A G I N E X T
H O W C A N Y O U F O S T E R
A C U L T U R E T H A T G E T S Y O U R
D E V E L O P E R S E X C I T E D A B O U T
D O C U M E N T A T I O N ?
H O W C A N Y O U F O S T E R
A C U L T U R E T H A T G E T S Y O U R
D E V E L O P E R S E X C I T E D A B O U T
P L E A S I N G T H E I R C U S T O M E R S ?
G A M E P L A N
• Why are docs important? What
makes good documentation? What
makes it un-agile?
• Waterfall to Agile transformation
• Kanban RICE transformation
• Scrum transformation
• Automation, Continuous
Documentation, Doc-First
• Who’s in charge?
W H Y D O N ’ T Y O U T H I N K D O C S
A R E A G I L E ?
W H Y A R E D O C S
R E J E C T E D ?
Feels like Waterfall, old school
Never enough time
Boring, a pain
Lack of ownership
Hot Potato Syndrome
“ I ’ V E S E E N F E W T E A M S W H O A R E
A C T U A L L Y A G I L E , W H E R E E V E R Y O N E
I S A B L E T O W O R K O N S T U F F A T T H E
S A M E T I M E , W H E R E Y O U G E T U P A N D
D O W N I N T H A T C I R C U L A R E F F E C T . I T
D O E S T E N D T O B E A S E R I E S O F M I N I -
W A T E R F A L L S . ”
@ A G I L E D O C
“ A P I D E S I G N - F I R S T I S I N H E R E N T L Y
N O T A G I L E . W E D E S I G N T H E W H O L E
T H I N G A N D T H E N T H R O W T H E
W H O L E T H I N G O V E R
[ D E C L A R I N G ] ‘ B E T H E R E C I P I E N T S
O F O U R W I S D O M ’ . ”
@ M A N P
“ T H I S I S T H E G O O D A N D B A D S I D E O F
A G I L E A U T O N O M Y … I N T H E E N D , I F I T ’ S
D O N E W I T H O U T C O N T R O L , W E W I L L H A V E
M A N Y M A N Y M I C R O S E R V I C E S T H A T
D O N ’ T S P E A K T H E S A M E L A N G U A G E A N D
I T W I L L C O S T A B U N C H O F M O N E Y . ”
@ A P I H A N D Y M A N
“ T H E P I E C E A B O U T I T B E I N G ‘ T H E N U M B E R -
O N E T H I N G P E O P L E W A N T ’ I S N ’ T
R E G I S T E R I N G A T M O S T C O M P A N I E S I S E R V E .
N O T A L L O F T H E M A R E I N T H E O P E N - S O U R C E
S P A C E , W H E R E D O C U M E N T A T I O N T R U L Y
S E L L S T H E P R O D U C T , B U T M O S T O F M Y
C L I E N T S T H I N K A B O U T D O C U M E N T A T I O N T O O
L A T E A N D R E S I S T P A Y I N G R E S P E C T A B L E
R A T E S W H E N T H E Y F I N D T H E R A R E
C O M B I N A T I O N O F D E V E L O P E R S K I L L S A N D
T E C H N I C A L W R I T I N G T A L E N T . ”
@ S Y N E R G I S T E C
H
W H Y D O Y O U N E E D
D O C U M E N T A T I O N ?
W H Y D O C S ?
• Cuts customer support
• Affects decision making
• For API consumers, most important
thing
• Shows you care about DX
• Internal efficiency
W H Y D O C S ?
• Only way to unite developer
autonomous world of containers,
microservices and the like
• Documentation = simpler code
• Allows you to prototype, write spec
• True collaboration = truly agile
D O C U M E N T A T I O N S H O U L D F I T I N T H E A G I L E
W O R L D “ B E C A U S E Y O U H A V E T H E A B I L I T Y T O
M O D I F Y T H E T H I N G T H A T D R I V E S T H E W H O L E
P R O C E S S A T A L M O S T E V E R Y S T A G E O F
D E V E L O P M E N T . A N D T H E M O D I F I C A T I O N S C A N
A F F E C T I N A C O N T R O L L E D W A Y A L L O F T H E
A R T I F A C T S T H A T A R E D O W N S T R E A M O F I T . ”
@ F E H G U Y
W H A T M A K E S F O R G O O D
D O C U M E N T A T I O N ?
W H A T I S G O O D
D O C U M E N T A T I O N ?
• Simple, to the point
• Personal, specific to user, major
personas
• Searchable
• Continuous
• Involves the consumer
“ I F I C A N ’ T D E S C R I B E I T A N D I ’ M
W O R K I N G A R O U N D S O M E T H I N G I N
T H E D O C U M E N T A T I O N , T H E N I
N E E D T O F I X S O M E T H I N G I N T H E
C O D E . ”
@ G J T O R I K I A N
H O W W O R L D P A Y W E N T F R O M
W A T E R F A L L T O A G I L E
W O R L D P A Y B E F O R E
@ W O R L D P A Y _ G L O B A
L
Devs in four countries
Frustrating APIs users struggled to use
P A T H F R O M W A T E R F A L L T O A G I L E
@ C R O W H U R S T S T E L L A
1. Survey Customers
2. Work with customer service
3. Lean: What were wastes in
process?
4. Gave two in-company workshops
- User personas
- Customer journey mapping
5. Gap Analysis — what were Stripe
and Braintree doing?
L E A N C U S T O M E R J O U R N E Y M A P P I N G
Where do they need docs?
What kinds of docs do they want?
What are their pain points?
@ C R O W H U R S T S T E L L A
“ W E T H I N K T H A T I F A P R O D U C T I S D E V E L O P E D
T H E R I G H T W A Y , U S E R S S H O U L D N ’ T R E A L L Y N E E D
D O C U M E N T A T I O N , B U T I N O U R E X P E R I E N C E
P E O P L E U S U A L L Y L O O K A T D O C U M E N T A T I O N
W H E N T H E Y H A V E A P R O B L E M O R , A S
D E V E L O P E R S , I S T H E T O O L T H E Y U S E T O W O R K
O N A D A Y - T O - D A Y B A S I S T O I N T E G R A T E . S O W H A T
W E D E C I D E D T O F O C U S O N W A S I N T E G R A T I O N
D O C U M E N T A T I O N A N D F A Q T O S U P P O R T U S E R S
W H E N T H E Y H A V E P R O B L E M S . ” "
@ C R O W H U R S T S T E L L A
H O W S E N D G R I D T R A N S F O R M E D
K A N B A N W I T H R I C E
S E N D G R I D B E F O R E
@ S E N D G R I D
Docs team went agile two years ago
Two week sprints
Huge docs debt
Reactionary documentation
Constantly updating priorities
Needed to prioritize for biggest impact
Highest score, gets top building
Prioritizes Kanban backlog
Solves for urgencies
Solves for size of project
Your ability to get it DONE
Transparency
R I C E F O R M U L A =
R E A C H X I M P A C T X C O N F I D E N C E
D I V I D E D B Y
E F F O R T
@ I N T E R C O M
@ M B E R N I E R
S E N D G R I D ’ S R I C E T W E A K S
Whole implementation took 30 minutes
RICE =
Reach X Impact X Confidence
X Business Imperative
X Due Date
divided by
Effort
Docs team +50% velocity in one month
OS team 2x velocity in one week
No more constant updating priorities
A spreadsheet calculates it all for them
3 lines in Excel > backlog in JIRA
S E N D G R I D ’ S R E S U L T S
@ M B E R N I E R
“When something doesn’t feel right?
Talk about it.”
Open-Source & Docs Teams:
“Everything can be agile.”
Efficiencies + frustrations = center
stage
Backlog transparency
S E N D G R I D ’ S R E S U L T S
@ M B E R N I E R
S C R U M : H O W C A N D O C S +
S P R I N T S E V E N W O R K ?
S H O U L D D O C S = D O N E ?
I F D O C S = S C R U M T H E N …
@ A G I L E D O C
Start early.
Sit side by side.
Continually updated.
Can’t be shipped if not documented.
Check in with UX + DX.
It ain’t for everybody…
" I F O N L Y T H E D E S I G N A T E D T E C H N I C A L W R I T E R
C A N P R O D U C E T H E D O C U M E N T A T I O N , Y O U ’ R E A
S I N G L E - F U N C T I O N A L T E A M . B E A R I N M I N D T H A T
A D D I N G A N A D D I T I O N A L W R I T E R W O N ' T M A K E Y O U
S E M I - F U N C T I O N A L , B E C A U S E D O C U M E N T A T I O N
C A N ' T C O M P L E T E U N T I L T E S T I N G C O M P L E T E S , S O
A D D I N G A N O T H E R W R I T E R W I L L G I V E Y O U M O R E
M A N P O W E R , B U T I T W O N ' T C H A N G E T H E I N H E R E N T
P R O B L E M T H A T S O F T W A R E D E V E L O P M E N T I S A
L I N E A R P R O C E S S . "
@ A G I L E D O C
C A N Y O U R S C R U M T E A M … ?
Question 1: Can Anyone other than
the tech writer complete the
documentation tasks?
@ A G I L E D O C
C A N Y O U R S C R U M T E A M … ?
Question 2: What portion of the docs
can be finished quickly by tech
writer?
@ A G I L E D O C
C A N Y O U R S C R U M T E A M … ?
Question 2: What portion of the docs
can be finished quickly by tech
writer?
>75% for single functional teams
>50% for semi-functional teams
@ A G I L E D O C
C A N Y O U R S C R U M T E A M … ?
Question 3: Is the documentation
consistently high quality?
@ A G I L E D O C
C A N Y O U R S C R U M T E A M … ?
Question 4: Is there only one
deliverable?
@ A G I L E D O C
C A N Y O U R S C R U M T E A M … ?
Question 5: Do you have a docs
guide, standards and templates?
@ A G I L E D O C
C A N Y O U R S C R U M T E A M … ?
Question 6: Does your team
enhance your documentation?
@ A G I L E D O C
C A N Y O U R S C R U M T E A M … ?
If YES to most of these, you can
move toward DOCS = DONE.
@ A G I L E D O C
“ D O C U M E N T A T I O N S H O U L D
N O T B E T H E P A R T O F T H E
S O F T W A R E D E V E L O P M E N T
P R O C E S S T H A T C A U S E S Y O U
T O N O T G E T Y O U R D E F I N I T I O N
O F D O N E . ”
@ A G I L E D O C
S O , H O W C A N D O C S J I V E W I T H
A G I L E ?
D O C S C U R A T O R & S T Y L E
G U I D E
H O W D O Y O U A U T O M A T E
D O C U M E N T A T I O N P R O C E S S E S ?
C R E A T E A D U P L I C A T A B L E
P R O C E S S , T H E N A U T O M A T E I T
S O Y O U D O N ’ T M I S S A N Y T H I N G
W H E R E T O A U T O M A T E
@ C H R I S C H I N C H
Markdown-Spellcheck
Doc style guide + quick reference list
Code example testing
Screenshot automation of successful
tests
“ O N E O F T H E T H I N G S T H A T W E
Q U I C K L Y R E A L I Z E D W E C O U L D N ’ T
D O W A S C R E A T E D O C U M E N T A T I O N
T H A T L I V E D A P A R T F R O M O U R
C O D E . I T H A D T O L I V E D I R E C T L Y
A L O N G S I D E O U R C O D E O R I T ’ D B E
I M M E D I A T E L Y O U T O F D A T E . ”
@ R V I S O T C K Y
D O C U M E N T A T I O N = D I S C I P L I N E
@ J K R I G G I N S
T H E P I E C E S O F T H E C H A N G I N G
D E V E L O P M E N T C Y C L E L I K E
C O N T A I N E R S A N D
M I C R O S E R V I C E S T H A T M A K E
D O C U M E N T A T I O N L E S S L I K E L Y
M E A N S I T ’ S A C T U A L L Y M O R E
N E C E S S A R Y . B U T T H E S E C A N A L L
L E A D T O E V E N B E T T E R , C O -
O W N E D D O C U M E N T A T I O N .
@ J K R I G G I N S
A G I L E D O C U M E N T A T I O N
= B E T T E R T E A M S
Everyone takes charge of own piece.
Everyone wants simple, explanatory
code (not self-explanatory.)
Individual developer can still be
creative, but has to communicate.
@ J K R I G G I N S
W H A T S T E P S W I L L Y O U T A K E ?
J E N N I F E R R I G G I N S @ J K R I G G I N S
# A G I N E X T
T H A N K S T O N E W O L D S T O C K F O R I M A G E S

Mais conteúdo relacionado

Mais procurados

Practical Approaches to Managing International Development Projects in the Fa...
Practical Approaches to Managing International Development Projects in the Fa...Practical Approaches to Managing International Development Projects in the Fa...
Practical Approaches to Managing International Development Projects in the Fa...
Emanuel Souvairan
 
From Content Strategy to Drupal Site Building - Connecting the dots
From Content Strategy to Drupal Site Building - Connecting the dotsFrom Content Strategy to Drupal Site Building - Connecting the dots
From Content Strategy to Drupal Site Building - Connecting the dots
Ronald Ashri
 
Practical Approaches to Managing International Development Projects in the Fa...
Practical Approaches to Managing International Development Projects in the Fa...Practical Approaches to Managing International Development Projects in the Fa...
Practical Approaches to Managing International Development Projects in the Fa...
Emanuel Souvairan
 

Mais procurados (20)

Visibility and societal impact : UMCG research output, Altmetric and Pure
Visibility and societal impact : UMCG research output, Altmetric and PureVisibility and societal impact : UMCG research output, Altmetric and Pure
Visibility and societal impact : UMCG research output, Altmetric and Pure
 
Quid - The Threat of AI
Quid - The Threat of AIQuid - The Threat of AI
Quid - The Threat of AI
 
eHarmony @ Phoenix Con 2016
eHarmony @ Phoenix Con 2016eHarmony @ Phoenix Con 2016
eHarmony @ Phoenix Con 2016
 
AWS Seminar Series 2015 Melbourne
AWS Seminar Series 2015 MelbourneAWS Seminar Series 2015 Melbourne
AWS Seminar Series 2015 Melbourne
 
AWS SeMINAR SERIES 2015 Sydney
AWS SeMINAR SERIES 2015 SydneyAWS SeMINAR SERIES 2015 Sydney
AWS SeMINAR SERIES 2015 Sydney
 
Practical Approaches to Managing International Development Projects in the Fa...
Practical Approaches to Managing International Development Projects in the Fa...Practical Approaches to Managing International Development Projects in the Fa...
Practical Approaches to Managing International Development Projects in the Fa...
 
From Content Strategy to Drupal Site Building - Connecting the dots
From Content Strategy to Drupal Site Building - Connecting the dotsFrom Content Strategy to Drupal Site Building - Connecting the dots
From Content Strategy to Drupal Site Building - Connecting the dots
 
Practical Approaches to Managing International Development Projects in the Fa...
Practical Approaches to Managing International Development Projects in the Fa...Practical Approaches to Managing International Development Projects in the Fa...
Practical Approaches to Managing International Development Projects in the Fa...
 
Practical Approaches to Managing International Development Projects in the Fa...
Practical Approaches to Managing International Development Projects in the Fa...Practical Approaches to Managing International Development Projects in the Fa...
Practical Approaches to Managing International Development Projects in the Fa...
 
AWS Seminar Series 2015 Brisbane
AWS Seminar Series 2015 BrisbaneAWS Seminar Series 2015 Brisbane
AWS Seminar Series 2015 Brisbane
 
Work in the web (Web Teaching Day 2015)
Work in the web (Web Teaching Day 2015)Work in the web (Web Teaching Day 2015)
Work in the web (Web Teaching Day 2015)
 
Data Visualizations in Digital Products (ProductCamp Boston 2016)
Data Visualizations in Digital Products (ProductCamp Boston 2016)Data Visualizations in Digital Products (ProductCamp Boston 2016)
Data Visualizations in Digital Products (ProductCamp Boston 2016)
 
Auckland AWS Seminar Series
Auckland AWS Seminar SeriesAuckland AWS Seminar Series
Auckland AWS Seminar Series
 
Alvis ownership-knowledge
Alvis ownership-knowledgeAlvis ownership-knowledge
Alvis ownership-knowledge
 
Yammer time
Yammer timeYammer time
Yammer time
 
Altmetrics in UMCG : pilot and update
Altmetrics in UMCG : pilot and updateAltmetrics in UMCG : pilot and update
Altmetrics in UMCG : pilot and update
 
Infographics webinar
Infographics webinar Infographics webinar
Infographics webinar
 
Topologi
Topologi Topologi
Topologi
 
Growth Framework for Consumer Startups
Growth Framework for Consumer StartupsGrowth Framework for Consumer Startups
Growth Framework for Consumer Startups
 
A Comparative Study of Data Management Maturity Models
A Comparative Study of Data Management Maturity ModelsA Comparative Study of Data Management Maturity Models
A Comparative Study of Data Management Maturity Models
 

Semelhante a How can documentation become inherently Agile?

multimediainfomediac17-180302055121.pdf
multimediainfomediac17-180302055121.pdfmultimediainfomediac17-180302055121.pdf
multimediainfomediac17-180302055121.pdf
ClaesTrinio
 

Semelhante a How can documentation become inherently Agile? (20)

i-lovelearning Madrid 2017 | The Role of L&D in the Modern Organisation [EN]
i-lovelearning Madrid 2017 | The Role of L&D in the Modern Organisation [EN]i-lovelearning Madrid 2017 | The Role of L&D in the Modern Organisation [EN]
i-lovelearning Madrid 2017 | The Role of L&D in the Modern Organisation [EN]
 
Almost Everything I've Learned From 5 Years of Lean UX
Almost Everything I've Learned From 5 Years of Lean UXAlmost Everything I've Learned From 5 Years of Lean UX
Almost Everything I've Learned From 5 Years of Lean UX
 
Lean UX: It really is about getting out of the deliverables business
Lean UX: It really is about getting out of the deliverables businessLean UX: It really is about getting out of the deliverables business
Lean UX: It really is about getting out of the deliverables business
 
20151015 earthsimulationoceanusoct
20151015 earthsimulationoceanusoct20151015 earthsimulationoceanusoct
20151015 earthsimulationoceanusoct
 
Lesson from 5 years of Lean UX
Lesson from 5 years of Lean UXLesson from 5 years of Lean UX
Lesson from 5 years of Lean UX
 
Before You Test Your System, Test Your Assumptions
Before You Test Your System, Test Your AssumptionsBefore You Test Your System, Test Your Assumptions
Before You Test Your System, Test Your Assumptions
 
Midterm Rehab
Midterm RehabMidterm Rehab
Midterm Rehab
 
UX in E-commerce & Conversion
UX in E-commerce & ConversionUX in E-commerce & Conversion
UX in E-commerce & Conversion
 
LSLS 2015 Keynote: Reframing Our Narratives
LSLS 2015 Keynote: Reframing Our NarrativesLSLS 2015 Keynote: Reframing Our Narratives
LSLS 2015 Keynote: Reframing Our Narratives
 
multimediainfomediac17-180302055121.pdf
multimediainfomediac17-180302055121.pdfmultimediainfomediac17-180302055121.pdf
multimediainfomediac17-180302055121.pdf
 
Hard to Reach Users in Easy to Reach Places
Hard to Reach Users in Easy to Reach PlacesHard to Reach Users in Easy to Reach Places
Hard to Reach Users in Easy to Reach Places
 
Erik Hanson -- Innovation in the Enterprise: Beyond the Pixels
Erik Hanson -- Innovation in the Enterprise: Beyond the PixelsErik Hanson -- Innovation in the Enterprise: Beyond the Pixels
Erik Hanson -- Innovation in the Enterprise: Beyond the Pixels
 
Unlocking intrapreneurship
Unlocking intrapreneurshipUnlocking intrapreneurship
Unlocking intrapreneurship
 
Multimedia information and Media
Multimedia information and MediaMultimedia information and Media
Multimedia information and Media
 
Gamification World Congress 2015 - Resumen
Gamification World Congress 2015 - Resumen Gamification World Congress 2015 - Resumen
Gamification World Congress 2015 - Resumen
 
SOCIAL MEDIA STRATEGIES TO BOOST YOUR PROFITS BY OVER 20%
SOCIAL MEDIA STRATEGIES TO BOOST YOUR PROFITS BY OVER 20%SOCIAL MEDIA STRATEGIES TO BOOST YOUR PROFITS BY OVER 20%
SOCIAL MEDIA STRATEGIES TO BOOST YOUR PROFITS BY OVER 20%
 
Security and Privacy in Healthcare
Security and Privacy in HealthcareSecurity and Privacy in Healthcare
Security and Privacy in Healthcare
 
What the Second Wave of Big Data Will Do to FinTech
What the Second Wave of Big Data Will Do to FinTechWhat the Second Wave of Big Data Will Do to FinTech
What the Second Wave of Big Data Will Do to FinTech
 
UX Poland 2016 - Jeff Gothelf - Almost Everything I've Learned From 5 Years o...
UX Poland 2016 - Jeff Gothelf - Almost Everything I've Learned From 5 Years o...UX Poland 2016 - Jeff Gothelf - Almost Everything I've Learned From 5 Years o...
UX Poland 2016 - Jeff Gothelf - Almost Everything I've Learned From 5 Years o...
 
Event Planning & Trends: Design, Technology & F&B
Event Planning & Trends: Design, Technology & F&BEvent Planning & Trends: Design, Technology & F&B
Event Planning & Trends: Design, Technology & F&B
 

Mais de eBranding Ninja

Mais de eBranding Ninja (7)

How (and why) to Factor Tech Ethics into Your Sprint
How (and why) to Factor Tech Ethics into Your SprintHow (and why) to Factor Tech Ethics into Your Sprint
How (and why) to Factor Tech Ethics into Your Sprint
 
Personal Branding for Women in Tech
Personal Branding for Women in TechPersonal Branding for Women in Tech
Personal Branding for Women in Tech
 
How Chatbots will overtake the app in 2017
How Chatbots will overtake the app in 2017How Chatbots will overtake the app in 2017
How Chatbots will overtake the app in 2017
 
Merit Money: Motivation Beats Traditional Bonus System
Merit Money: Motivation Beats Traditional Bonus SystemMerit Money: Motivation Beats Traditional Bonus System
Merit Money: Motivation Beats Traditional Bonus System
 
What is Personal Branding? A Starter Guide
What is Personal Branding? A Starter Guide What is Personal Branding? A Starter Guide
What is Personal Branding? A Starter Guide
 
How to Make LinkedIn Work for You
How to Make LinkedIn Work for YouHow to Make LinkedIn Work for You
How to Make LinkedIn Work for You
 
How to Pitch Like a Rockstar
How to Pitch Like a RockstarHow to Pitch Like a Rockstar
How to Pitch Like a Rockstar
 

Último

+971565801893>>SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHAB...
+971565801893>>SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHAB...+971565801893>>SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHAB...
+971565801893>>SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHAB...
Health
 
TECUNIQUE: Success Stories: IT Service provider
TECUNIQUE: Success Stories: IT Service providerTECUNIQUE: Success Stories: IT Service provider
TECUNIQUE: Success Stories: IT Service provider
mohitmore19
 
CHEAP Call Girls in Pushp Vihar (-DELHI )🔝 9953056974🔝(=)/CALL GIRLS SERVICE
CHEAP Call Girls in Pushp Vihar (-DELHI )🔝 9953056974🔝(=)/CALL GIRLS SERVICECHEAP Call Girls in Pushp Vihar (-DELHI )🔝 9953056974🔝(=)/CALL GIRLS SERVICE
CHEAP Call Girls in Pushp Vihar (-DELHI )🔝 9953056974🔝(=)/CALL GIRLS SERVICE
9953056974 Low Rate Call Girls In Saket, Delhi NCR
 
AI Mastery 201: Elevating Your Workflow with Advanced LLM Techniques
AI Mastery 201: Elevating Your Workflow with Advanced LLM TechniquesAI Mastery 201: Elevating Your Workflow with Advanced LLM Techniques
AI Mastery 201: Elevating Your Workflow with Advanced LLM Techniques
VictorSzoltysek
 

Último (20)

HR Software Buyers Guide in 2024 - HRSoftware.com
HR Software Buyers Guide in 2024 - HRSoftware.comHR Software Buyers Guide in 2024 - HRSoftware.com
HR Software Buyers Guide in 2024 - HRSoftware.com
 
Introducing Microsoft’s new Enterprise Work Management (EWM) Solution
Introducing Microsoft’s new Enterprise Work Management (EWM) SolutionIntroducing Microsoft’s new Enterprise Work Management (EWM) Solution
Introducing Microsoft’s new Enterprise Work Management (EWM) Solution
 
Tech Tuesday-Harness the Power of Effective Resource Planning with OnePlan’s ...
Tech Tuesday-Harness the Power of Effective Resource Planning with OnePlan’s ...Tech Tuesday-Harness the Power of Effective Resource Planning with OnePlan’s ...
Tech Tuesday-Harness the Power of Effective Resource Planning with OnePlan’s ...
 
Unveiling the Tech Salsa of LAMs with Janus in Real-Time Applications
Unveiling the Tech Salsa of LAMs with Janus in Real-Time ApplicationsUnveiling the Tech Salsa of LAMs with Janus in Real-Time Applications
Unveiling the Tech Salsa of LAMs with Janus in Real-Time Applications
 
A Secure and Reliable Document Management System is Essential.docx
A Secure and Reliable Document Management System is Essential.docxA Secure and Reliable Document Management System is Essential.docx
A Secure and Reliable Document Management System is Essential.docx
 
+971565801893>>SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHAB...
+971565801893>>SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHAB...+971565801893>>SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHAB...
+971565801893>>SAFE AND ORIGINAL ABORTION PILLS FOR SALE IN DUBAI AND ABUDHAB...
 
Learn the Fundamentals of XCUITest Framework_ A Beginner's Guide.pdf
Learn the Fundamentals of XCUITest Framework_ A Beginner's Guide.pdfLearn the Fundamentals of XCUITest Framework_ A Beginner's Guide.pdf
Learn the Fundamentals of XCUITest Framework_ A Beginner's Guide.pdf
 
How To Use Server-Side Rendering with Nuxt.js
How To Use Server-Side Rendering with Nuxt.jsHow To Use Server-Side Rendering with Nuxt.js
How To Use Server-Side Rendering with Nuxt.js
 
How to Choose the Right Laravel Development Partner in New York City_compress...
How to Choose the Right Laravel Development Partner in New York City_compress...How to Choose the Right Laravel Development Partner in New York City_compress...
How to Choose the Right Laravel Development Partner in New York City_compress...
 
TECUNIQUE: Success Stories: IT Service provider
TECUNIQUE: Success Stories: IT Service providerTECUNIQUE: Success Stories: IT Service provider
TECUNIQUE: Success Stories: IT Service provider
 
Exploring the Best Video Editing App.pdf
Exploring the Best Video Editing App.pdfExploring the Best Video Editing App.pdf
Exploring the Best Video Editing App.pdf
 
Reassessing the Bedrock of Clinical Function Models: An Examination of Large ...
Reassessing the Bedrock of Clinical Function Models: An Examination of Large ...Reassessing the Bedrock of Clinical Function Models: An Examination of Large ...
Reassessing the Bedrock of Clinical Function Models: An Examination of Large ...
 
CHEAP Call Girls in Pushp Vihar (-DELHI )🔝 9953056974🔝(=)/CALL GIRLS SERVICE
CHEAP Call Girls in Pushp Vihar (-DELHI )🔝 9953056974🔝(=)/CALL GIRLS SERVICECHEAP Call Girls in Pushp Vihar (-DELHI )🔝 9953056974🔝(=)/CALL GIRLS SERVICE
CHEAP Call Girls in Pushp Vihar (-DELHI )🔝 9953056974🔝(=)/CALL GIRLS SERVICE
 
Vip Call Girls Noida ➡️ Delhi ➡️ 9999965857 No Advance 24HRS Live
Vip Call Girls Noida ➡️ Delhi ➡️ 9999965857 No Advance 24HRS LiveVip Call Girls Noida ➡️ Delhi ➡️ 9999965857 No Advance 24HRS Live
Vip Call Girls Noida ➡️ Delhi ➡️ 9999965857 No Advance 24HRS Live
 
Direct Style Effect Systems - The Print[A] Example - A Comprehension Aid
Direct Style Effect Systems -The Print[A] Example- A Comprehension AidDirect Style Effect Systems -The Print[A] Example- A Comprehension Aid
Direct Style Effect Systems - The Print[A] Example - A Comprehension Aid
 
8257 interfacing 2 in microprocessor for btech students
8257 interfacing 2 in microprocessor for btech students8257 interfacing 2 in microprocessor for btech students
8257 interfacing 2 in microprocessor for btech students
 
AI Mastery 201: Elevating Your Workflow with Advanced LLM Techniques
AI Mastery 201: Elevating Your Workflow with Advanced LLM TechniquesAI Mastery 201: Elevating Your Workflow with Advanced LLM Techniques
AI Mastery 201: Elevating Your Workflow with Advanced LLM Techniques
 
Right Money Management App For Your Financial Goals
Right Money Management App For Your Financial GoalsRight Money Management App For Your Financial Goals
Right Money Management App For Your Financial Goals
 
The Ultimate Test Automation Guide_ Best Practices and Tips.pdf
The Ultimate Test Automation Guide_ Best Practices and Tips.pdfThe Ultimate Test Automation Guide_ Best Practices and Tips.pdf
The Ultimate Test Automation Guide_ Best Practices and Tips.pdf
 
Software Quality Assurance Interview Questions
Software Quality Assurance Interview QuestionsSoftware Quality Assurance Interview Questions
Software Quality Assurance Interview Questions
 

How can documentation become inherently Agile?

  • 1. H O W C A N D O C U M E N T A T I O N B E C O M E I N H E R E N T L Y A G I L E ? J E N N I F E R R I G G I N S @ J K R I G G I N S # A G I N E X T
  • 2. H O W C A N Y O U F O S T E R A C U L T U R E T H A T G E T S Y O U R D E V E L O P E R S E X C I T E D A B O U T D O C U M E N T A T I O N ?
  • 3. H O W C A N Y O U F O S T E R A C U L T U R E T H A T G E T S Y O U R D E V E L O P E R S E X C I T E D A B O U T P L E A S I N G T H E I R C U S T O M E R S ?
  • 4. G A M E P L A N • Why are docs important? What makes good documentation? What makes it un-agile? • Waterfall to Agile transformation • Kanban RICE transformation • Scrum transformation • Automation, Continuous Documentation, Doc-First • Who’s in charge?
  • 5. W H Y D O N ’ T Y O U T H I N K D O C S A R E A G I L E ?
  • 6. W H Y A R E D O C S R E J E C T E D ? Feels like Waterfall, old school Never enough time Boring, a pain Lack of ownership Hot Potato Syndrome
  • 7. “ I ’ V E S E E N F E W T E A M S W H O A R E A C T U A L L Y A G I L E , W H E R E E V E R Y O N E I S A B L E T O W O R K O N S T U F F A T T H E S A M E T I M E , W H E R E Y O U G E T U P A N D D O W N I N T H A T C I R C U L A R E F F E C T . I T D O E S T E N D T O B E A S E R I E S O F M I N I - W A T E R F A L L S . ” @ A G I L E D O C
  • 8. “ A P I D E S I G N - F I R S T I S I N H E R E N T L Y N O T A G I L E . W E D E S I G N T H E W H O L E T H I N G A N D T H E N T H R O W T H E W H O L E T H I N G O V E R [ D E C L A R I N G ] ‘ B E T H E R E C I P I E N T S O F O U R W I S D O M ’ . ” @ M A N P
  • 9. “ T H I S I S T H E G O O D A N D B A D S I D E O F A G I L E A U T O N O M Y … I N T H E E N D , I F I T ’ S D O N E W I T H O U T C O N T R O L , W E W I L L H A V E M A N Y M A N Y M I C R O S E R V I C E S T H A T D O N ’ T S P E A K T H E S A M E L A N G U A G E A N D I T W I L L C O S T A B U N C H O F M O N E Y . ” @ A P I H A N D Y M A N
  • 10. “ T H E P I E C E A B O U T I T B E I N G ‘ T H E N U M B E R - O N E T H I N G P E O P L E W A N T ’ I S N ’ T R E G I S T E R I N G A T M O S T C O M P A N I E S I S E R V E . N O T A L L O F T H E M A R E I N T H E O P E N - S O U R C E S P A C E , W H E R E D O C U M E N T A T I O N T R U L Y S E L L S T H E P R O D U C T , B U T M O S T O F M Y C L I E N T S T H I N K A B O U T D O C U M E N T A T I O N T O O L A T E A N D R E S I S T P A Y I N G R E S P E C T A B L E R A T E S W H E N T H E Y F I N D T H E R A R E C O M B I N A T I O N O F D E V E L O P E R S K I L L S A N D T E C H N I C A L W R I T I N G T A L E N T . ” @ S Y N E R G I S T E C H
  • 11. W H Y D O Y O U N E E D D O C U M E N T A T I O N ?
  • 12. W H Y D O C S ? • Cuts customer support • Affects decision making • For API consumers, most important thing • Shows you care about DX • Internal efficiency
  • 13. W H Y D O C S ? • Only way to unite developer autonomous world of containers, microservices and the like • Documentation = simpler code • Allows you to prototype, write spec • True collaboration = truly agile
  • 14. D O C U M E N T A T I O N S H O U L D F I T I N T H E A G I L E W O R L D “ B E C A U S E Y O U H A V E T H E A B I L I T Y T O M O D I F Y T H E T H I N G T H A T D R I V E S T H E W H O L E P R O C E S S A T A L M O S T E V E R Y S T A G E O F D E V E L O P M E N T . A N D T H E M O D I F I C A T I O N S C A N A F F E C T I N A C O N T R O L L E D W A Y A L L O F T H E A R T I F A C T S T H A T A R E D O W N S T R E A M O F I T . ” @ F E H G U Y
  • 15. W H A T M A K E S F O R G O O D D O C U M E N T A T I O N ?
  • 16. W H A T I S G O O D D O C U M E N T A T I O N ? • Simple, to the point • Personal, specific to user, major personas • Searchable • Continuous • Involves the consumer
  • 17. “ I F I C A N ’ T D E S C R I B E I T A N D I ’ M W O R K I N G A R O U N D S O M E T H I N G I N T H E D O C U M E N T A T I O N , T H E N I N E E D T O F I X S O M E T H I N G I N T H E C O D E . ” @ G J T O R I K I A N
  • 18. H O W W O R L D P A Y W E N T F R O M W A T E R F A L L T O A G I L E
  • 19. W O R L D P A Y B E F O R E @ W O R L D P A Y _ G L O B A L Devs in four countries Frustrating APIs users struggled to use
  • 20. P A T H F R O M W A T E R F A L L T O A G I L E @ C R O W H U R S T S T E L L A 1. Survey Customers 2. Work with customer service 3. Lean: What were wastes in process? 4. Gave two in-company workshops - User personas - Customer journey mapping 5. Gap Analysis — what were Stripe and Braintree doing?
  • 21. L E A N C U S T O M E R J O U R N E Y M A P P I N G Where do they need docs? What kinds of docs do they want? What are their pain points? @ C R O W H U R S T S T E L L A
  • 22. “ W E T H I N K T H A T I F A P R O D U C T I S D E V E L O P E D T H E R I G H T W A Y , U S E R S S H O U L D N ’ T R E A L L Y N E E D D O C U M E N T A T I O N , B U T I N O U R E X P E R I E N C E P E O P L E U S U A L L Y L O O K A T D O C U M E N T A T I O N W H E N T H E Y H A V E A P R O B L E M O R , A S D E V E L O P E R S , I S T H E T O O L T H E Y U S E T O W O R K O N A D A Y - T O - D A Y B A S I S T O I N T E G R A T E . S O W H A T W E D E C I D E D T O F O C U S O N W A S I N T E G R A T I O N D O C U M E N T A T I O N A N D F A Q T O S U P P O R T U S E R S W H E N T H E Y H A V E P R O B L E M S . ” " @ C R O W H U R S T S T E L L A
  • 23. H O W S E N D G R I D T R A N S F O R M E D K A N B A N W I T H R I C E
  • 24. S E N D G R I D B E F O R E @ S E N D G R I D Docs team went agile two years ago Two week sprints Huge docs debt Reactionary documentation Constantly updating priorities Needed to prioritize for biggest impact
  • 25. Highest score, gets top building Prioritizes Kanban backlog Solves for urgencies Solves for size of project Your ability to get it DONE Transparency R I C E F O R M U L A = R E A C H X I M P A C T X C O N F I D E N C E D I V I D E D B Y E F F O R T @ I N T E R C O M
  • 26. @ M B E R N I E R S E N D G R I D ’ S R I C E T W E A K S Whole implementation took 30 minutes RICE = Reach X Impact X Confidence X Business Imperative X Due Date divided by Effort
  • 27. Docs team +50% velocity in one month OS team 2x velocity in one week No more constant updating priorities A spreadsheet calculates it all for them 3 lines in Excel > backlog in JIRA S E N D G R I D ’ S R E S U L T S @ M B E R N I E R
  • 28. “When something doesn’t feel right? Talk about it.” Open-Source & Docs Teams: “Everything can be agile.” Efficiencies + frustrations = center stage Backlog transparency S E N D G R I D ’ S R E S U L T S @ M B E R N I E R
  • 29. S C R U M : H O W C A N D O C S + S P R I N T S E V E N W O R K ?
  • 30. S H O U L D D O C S = D O N E ?
  • 31. I F D O C S = S C R U M T H E N … @ A G I L E D O C Start early. Sit side by side. Continually updated. Can’t be shipped if not documented. Check in with UX + DX. It ain’t for everybody…
  • 32. " I F O N L Y T H E D E S I G N A T E D T E C H N I C A L W R I T E R C A N P R O D U C E T H E D O C U M E N T A T I O N , Y O U ’ R E A S I N G L E - F U N C T I O N A L T E A M . B E A R I N M I N D T H A T A D D I N G A N A D D I T I O N A L W R I T E R W O N ' T M A K E Y O U S E M I - F U N C T I O N A L , B E C A U S E D O C U M E N T A T I O N C A N ' T C O M P L E T E U N T I L T E S T I N G C O M P L E T E S , S O A D D I N G A N O T H E R W R I T E R W I L L G I V E Y O U M O R E M A N P O W E R , B U T I T W O N ' T C H A N G E T H E I N H E R E N T P R O B L E M T H A T S O F T W A R E D E V E L O P M E N T I S A L I N E A R P R O C E S S . " @ A G I L E D O C
  • 33. C A N Y O U R S C R U M T E A M … ? Question 1: Can Anyone other than the tech writer complete the documentation tasks? @ A G I L E D O C
  • 34. C A N Y O U R S C R U M T E A M … ? Question 2: What portion of the docs can be finished quickly by tech writer? @ A G I L E D O C
  • 35. C A N Y O U R S C R U M T E A M … ? Question 2: What portion of the docs can be finished quickly by tech writer? >75% for single functional teams >50% for semi-functional teams @ A G I L E D O C
  • 36. C A N Y O U R S C R U M T E A M … ? Question 3: Is the documentation consistently high quality? @ A G I L E D O C
  • 37. C A N Y O U R S C R U M T E A M … ? Question 4: Is there only one deliverable? @ A G I L E D O C
  • 38. C A N Y O U R S C R U M T E A M … ? Question 5: Do you have a docs guide, standards and templates? @ A G I L E D O C
  • 39. C A N Y O U R S C R U M T E A M … ? Question 6: Does your team enhance your documentation? @ A G I L E D O C
  • 40. C A N Y O U R S C R U M T E A M … ? If YES to most of these, you can move toward DOCS = DONE. @ A G I L E D O C
  • 41. “ D O C U M E N T A T I O N S H O U L D N O T B E T H E P A R T O F T H E S O F T W A R E D E V E L O P M E N T P R O C E S S T H A T C A U S E S Y O U T O N O T G E T Y O U R D E F I N I T I O N O F D O N E . ” @ A G I L E D O C
  • 42. S O , H O W C A N D O C S J I V E W I T H A G I L E ?
  • 43. D O C S C U R A T O R & S T Y L E G U I D E
  • 44. H O W D O Y O U A U T O M A T E D O C U M E N T A T I O N P R O C E S S E S ?
  • 45. C R E A T E A D U P L I C A T A B L E P R O C E S S , T H E N A U T O M A T E I T S O Y O U D O N ’ T M I S S A N Y T H I N G
  • 46. W H E R E T O A U T O M A T E @ C H R I S C H I N C H Markdown-Spellcheck Doc style guide + quick reference list Code example testing Screenshot automation of successful tests
  • 47. “ O N E O F T H E T H I N G S T H A T W E Q U I C K L Y R E A L I Z E D W E C O U L D N ’ T D O W A S C R E A T E D O C U M E N T A T I O N T H A T L I V E D A P A R T F R O M O U R C O D E . I T H A D T O L I V E D I R E C T L Y A L O N G S I D E O U R C O D E O R I T ’ D B E I M M E D I A T E L Y O U T O F D A T E . ” @ R V I S O T C K Y
  • 48. D O C U M E N T A T I O N = D I S C I P L I N E @ J K R I G G I N S
  • 49. T H E P I E C E S O F T H E C H A N G I N G D E V E L O P M E N T C Y C L E L I K E C O N T A I N E R S A N D M I C R O S E R V I C E S T H A T M A K E D O C U M E N T A T I O N L E S S L I K E L Y M E A N S I T ’ S A C T U A L L Y M O R E N E C E S S A R Y . B U T T H E S E C A N A L L L E A D T O E V E N B E T T E R , C O - O W N E D D O C U M E N T A T I O N . @ J K R I G G I N S
  • 50. A G I L E D O C U M E N T A T I O N = B E T T E R T E A M S Everyone takes charge of own piece. Everyone wants simple, explanatory code (not self-explanatory.) Individual developer can still be creative, but has to communicate. @ J K R I G G I N S
  • 51. W H A T S T E P S W I L L Y O U T A K E ? J E N N I F E R R I G G I N S @ J K R I G G I N S # A G I N E X T T H A N K S T O N E W O L D S T O C K F O R I M A G E S

Notas do Editor

  1. Add Intercom logo
  2. Or a top-down management approach?
  3. ROB WOODGATE agile docs consultant
  4.  Emmanuel Paraskakis, head of product development at APIary (currently being acquired by Oracle). Which is why I argue Doc-first APIs not APIs first. In fact I argue a move toward continuous documentation and even Docs-first
  5. Arnaud
  6. Andrew Davis
  7. ask screen before But isn’t Documentation just a vestige of waterfall? Soaked man Or a top-down management approach?
  8. Of course Tony Tam is biased as the inventor of Swagger but you get the idea Documentation should fit in the agile world “because you have the ability to modify the thing that drives the whole process at almost every stage of development. And the modifications can affect in a controlled way all of the artifacts that are downstream of it.”
  9. ADD MORE
  10. Of course Tony Tam is biased as the inventor of Swagger but you get the idea
  11. “We think that if a product is developed the right way, users shouldn’t really need documentation, but in our experience people usually look at documentation when they have a problem or, as developers, is the tool they use to work on a day-to-day basis to integrate. So what we decided to focus on was integration documentation and FAQ to support users when they have problems.”"
  12. documentation became reactionary to support team needs never felt like they are getting anything done, never finishing a sprint
  13. Add intercom logo highest RICE score gets top billing — and then gives us the opportunity to communicate with the rest of the business to know priority — number 5 vs 22 — if you as the requester can give us more info we can raise our confidence level which will push it up in the backlog Kanban means constantly updating priorities Sendgrid just use a spreadsheet, sorting based on RICE score and formula
  14. rice formula= reach X impact x confidence divided by effort we tend to question our process a lot and what can we automate three sentences of spreadsheet vs backlog form in JIRA looking for little efficiencies and frustrations to optimize
  15. quantifiable
  16. cultural we tend to question our process a lot and what can we automate three sentences of spreadsheet vs backlog form in JIRA looking for little efficiencies and frustrations to optimize
  17. ROB WOODGATE agile docs consultant
  18. >75% for single functional teams >50% for semi-functional teams
  19. >75% for single functional teams >50% for semi-functional teams
  20. Question 3: Is the documentation consistently high quality? (something that shows haphazard and fast)
  21. Question 5: Do you have a docs guide, standards and templates?
  22. Question 5: Do you have a docs guide, standards and templates?
  23. “Documentation should not be the part of the software development process that causes you to not get your definition of done.”
  24. In the end, docs are boring and often repeatable, so you want to automate the crap out of it
  25. humans aren’t very good at repeatable tasks, but machines are
  26. uses open source dictionary files. Adjust your script to your preferences (e.g. report mode, ignore numbers and acronyms). Create a separate repository with the typical custom language (not a real word, but not wrong), so they won't get flagged by the checker. Decide what to let through. Can add to your own dictionary, customize for words that aren’t real words but aren’t wrong and integrate with even Open Office
  27. Agile Coach Rich
  28. What interruptions are constantly pointed to as excuses for not completing doc address repeated issues with automation
  29. The pieces of the changing development cycle like containers that makes documentation less likely but more necessary can be used for great documentation