SlideShare une entreprise Scribd logo
1  sur  46
Télécharger pour lire hors ligne
Fabian Kiss
                       Sep 2011
Scrum User Group Lake Constance
DO AGILISTES NEED DOCUMENTATION?
THE MANIFESTO ON DOCUMENTATION


     Manifesto for Agile Software Development


           We are uncovering better ways of developing
           software by doing it and helping others do it.
            Through this work we have come to value:

     Individuals and interactions over processes and tools
     Working software over comprehensive documentation
       Customer collaboration over contract negotiation
         Responding to change over following a plan
            That is, while there is value in the items on
           the right, we value the items on the left more.
THE MANIFESTO ON DOCUMENTATION


     Manifesto for Agile Software Development


           We are uncovering better ways of developing
           software by doing it and helping others do it.
            Through this work we have come to value:

     Individuals and interactions over processes and tools
     Working software over comprehensive documentation
       Customer collaboration over contract negotiation
         Responding to change over following a plan
            That is, while there is value in the items on
           the right, we value the items on the left more.
LET'S HAVE A CLOSER
LOOK AT SOME DEFINITIONS
AGILE PROCESS



   Definition by values and practices (Manifesto & beyond)
AGILE PROCESS




        Agile Software Development Poster by VersionOne, Inc., 2011, licensed under the CC BY-SA 3.0
AGILE PROCESS



   Definition by values and practices (Manifesto & beyond)
   Definition by “SDLC coverage”
AGILE PROCESS




  From Agile Software Development Methods: Review and Analysis by Abrahamsson, P., Salo, O., Ronkainen, J., & Warsta, J., 2002, licensed under the CC BY-SA 3.0
AGILE PROCESS



   Definition by values and practices (Manifesto & beyond)
   Definition by “SDLC coverage”
   Definition by ...

         There is a common understanding of what an agile software
         development process is
DOCUMENTATION

Virtually no definition of documentation
(in respect of software development)
DOCUMENTATION

Virtually no definition of documentation
(in respect of software development)

   From the developer's perspective: source code documentation
   From the project stakeholder's perspective: system documentation
DOCUMENTATION

Virtually no definition of documentation
(in respect of software development)

   From the developer's perspective: source code documentation
   From the project stakeholder's perspective: system documentation
   More general: software documentation
       Umbrella term for any documentation related to a software product
DOCUMENTATION

Virtually no definition of documentation
(in respect of software development)

   From the developer's perspective: source code documentation
   From the project stakeholder's perspective: system documentation
   More general: software documentation
       Umbrella term for any documentation related to a software product


          People think of different things when referring to documentation
DOCUMENTATION




Proposal for an initial classification:

Documentation dealing with properties of a software product ...
   ... during its development
   ... after its completion
BOOKS ABOUT AGILE DOCUMENTATION




Picture by Jeremy Nelson, licensed under the CC BY-NC-SA 2.0
S.W. AMBLER: 'AGILE MODELING'


Scott W. Ambler

Agile Modeling: Effective Practices for
eXtreme Programming and the Unified Process

Wiley
2002
S.W. AMBLER: 'AGILE MODELING'




Chapter about agile documentation
(www.agilemodeling.com holds a more recent version of it)

Values, principles and practices for Agile Modeling adopted from
XP/Agile values, principles and practices
S.W. AMBLER: 'AGILE MODELING'




One of his values in the context of documentation:

“The fundamental issue is communication, not documentation.”
From Agile/Lean Documentation: Strategies for Agile Software Development by Scott W. Ambler, http://www.agilemodeling.com/essays/agileDocumentation.htm#CriticalPoints
S.W. AMBLER: 'AGILE MODELING'




One of his principles in the context of documentation:

“Travel Light. Every artifact that you create, and then decide to keep, will
need to be maintained over time.”
From Agile Modeling (AM) Principles v2 by Scott W. Ambler, http://www.agilemodeling.com/principles.htm#TravelLight
S.W. AMBLER: 'AGILE MODELING'


Two of his practices in the context of documentation:

“Executable specifications, for example [...] a developer test-suite [...].
Because these artifacts add value there is a significantly greater chance
that developers will keep them up-to-date.”
From Agile/Lean Documentation: Strategies for Agile Software Development by Scott W. Ambler,
http://www.agilemodeling.com/essays/agileDocumentation.htm#IssuesWithDocumentation
S.W. AMBLER: 'AGILE MODELING'


Two of his practices in the context of documentation:

“Executable specifications, for example [...] a developer test-suite [...].
Because these artifacts add value there is a significantly greater chance
that developers will keep them up-to-date.”
From Agile/Lean Documentation: Strategies for Agile Software Development by Scott W. Ambler,
http://www.agilemodeling.com/essays/agileDocumentation.htm#IssuesWithDocumentation




"Document stable concepts, not speculative concepts, and thereby document
as late as possible in the life cycle."
From Agile/Lean Documentation: Strategies for Agile Software Development by Scott W. Ambler,
http://www.agilemodeling.com/essays/agileDocumentation.htm#WhenToCreateDocumentation
S.W. AMBLER: 'AGILE MODELING'


Two of his practices in the context of documentation:

“Executable specifications, for example [...] a developer test-suite [...].
Because these artifacts add value there is a significantly greater chance
that developers will keep them up-to-date.”
From Agile/Lean Documentation: Strategies for Agile Software Development by Scott W. Ambler,
http://www.agilemodeling.com/essays/agileDocumentation.htm#IssuesWithDocumentation




"Document stable concepts, not speculative concepts, and thereby document
as late as possible in the life cycle."                                                                      t
From Agile/Lean Documentation: Strategies for Agile Software Development by Scott W. Ambler,
                                                                                             whe n to documen
http://www.agilemodeling.com/essays/agileDocumentation.htm#WhenToCreateDocumentation
THE DOWNSIDE...
S.W. AMBLER: 'AGILE MODELING'




Strongly influenced by Agile Modeling (the author's major interest)
   AM as a certain agile methodology
   AMDD as a certain software development approach
S.W. AMBLER: 'AGILE MODELING'




Strongly influenced by Agile Modeling (the author's major interest)
   AM as a certain agile methodology
   AMDD as a certain software development approach

          Limits generality
A. RÜPING: 'AGILE DOCUMENTATION'


Andreas Rüping

Agile Documentation: A Pattern Guide to Producing
Lightweight Documents for Software Projects

Wiley
2003
                      (It's
                            a
                     app comple
                           a
                  can rently tely dif
                       not           t          f
                 fr o n      affo he pub erent b
                                  rd d        l
                        t co
                             v er       esig isher s ook,
                                  fo r      ning        imp
                                       each         a un l y
                                            of i t       ique
                                                   s bo
                                                        oks)
A. RÜPING: 'AGILE DOCUMENTATION'




Patterns as descriptions of solutions to certain documentation issues in
agile software projects, divided into five categories:

1. Finding the Right Topics
2. Structuring Individual Documents
3. Layout and Typography
4. Infrastructure and Technical Organisation
5. Management and Quality Assurance
A. RÜPING: 'AGILE DOCUMENTATION'

Examples (“Pattern Thumbnails”):




             From Agile Documentation: A Pattern Guide to Producing Lightweight Documents for Software Projects by Andreas Rüping, 2003, Wiley, p. 198
A. RÜPING: 'AGILE DOCUMENTATION'

Examples (“Pattern Thumbnails”):




             From Agile Documentation: A Pattern Guide to Producing Lightweight Documents for Software Projects by Andreas Rüping, 2003, Wiley, p. 198




             From Agile Documentation: A Pattern Guide to Producing Lightweight Documents for Software Projects by Andreas Rüping, 2003, Wiley, p. 201
A. RÜPING: 'AGILE DOCUMENTATION'




Furthermore...

“Different people grasp information at different speeds. […] Documents
[…] allow people to read at their own pace.”
From Agile Documentation: A Pattern Guide to Producing Lightweight Documents for Software Projects by Andreas Rüping, 2003, Wiley, p. 20
A. RÜPING: 'AGILE DOCUMENTATION'




Furthermore...

“Different people grasp information at different speeds. […] Documents
[…] allow people to read at their own pace.”
From Agile Documentation: A Pattern Guide to Producing Lightweight Documents for Software Projects by Andreas Rüping, 2003, Wiley, p. 20




                                                                                 agile principle
                                                                                                 s'                     relation to ind
                                                                                                                                       ividuals
AGAIN, A
DOWN-
SIDE...
A. RÜPING: 'AGILE DOCUMENTATION'




Obviously the patterns are more or less specific to agile software
development
A. RÜPING: 'AGILE DOCUMENTATION'




Obviously the patterns are more or less specific to agile software
development

       Some problems unique for documentation in agile software
       development might not be addressed at all
Picture by César Astudillo, licensed under the CC BY-NC 2.0
Documentation itself is simply a too broad topic ...
Documentation itself is simply a too broad topic ...




                         … even agile documentation is still something
                         very unspecific
SOME OPTIMISM PLEASE!




Picture by LawPrieR, licensed under the CC BY-NC 2.0
Before considering (or developing) any practices, patterns or other forms
of advice for agile documentation, we should further delimit the scope!
Before considering (or developing) any practices, patterns or other forms
of advice for agile documentation, we should further delimit the scope!
Before considering (or developing) any practices, patterns or other forms
of advice for agile documentation, we should further delimit the scope!




               Documentation for during/after development
Before considering (or developing) any practices, patterns or other forms
of advice for agile documentation, we should further delimit the scope!




            ✔   Documentation for during/after development
               Who documents for whom?
Before considering (or developing) any practices, patterns or other forms
of advice for agile documentation, we should further delimit the scope!




            ✔   Documentation for during/after development
               Who documents for whom?
               Documenting for what specific purpose?
Before considering (or developing) any practices, patterns or other forms
of advice for agile documentation, we should further delimit the scope!




            ✔   Documentation for during/after development
               Who documents for whom?
               Documenting for what specific purpose?
               ...

Contenu connexe

Tendances

What is Agile Methodology?
What is Agile Methodology?What is Agile Methodology?
What is Agile Methodology?QA InfoTech
 
Incremental model presentation
Incremental model presentationIncremental model presentation
Incremental model presentationNiat Murad
 
Rapid Application Development Model
Rapid Application Development ModelRapid Application Development Model
Rapid Application Development ModelDamian T. Gordon
 
What is agile model?Working of agile model
What is agile model?Working of agile modelWhat is agile model?Working of agile model
What is agile model?Working of agile modelzoomers
 
Chapter19 rapid application development
Chapter19 rapid application developmentChapter19 rapid application development
Chapter19 rapid application developmentDhani Ahmad
 
Introduction agile scrum methodology
Introduction agile scrum methodologyIntroduction agile scrum methodology
Introduction agile scrum methodologyAmit Verma
 
Overview of Agile Methodology
Overview of Agile MethodologyOverview of Agile Methodology
Overview of Agile MethodologyHaresh Karkar
 
V model presentation
V model presentationV model presentation
V model presentationNiat Murad
 
Software Development Methodologies
Software Development MethodologiesSoftware Development Methodologies
Software Development MethodologiesNicholas Davis
 
Software project management
Software project managementSoftware project management
Software project managementR A Akerkar
 
Agile Methodology - Software Engineering
Agile Methodology - Software EngineeringAgile Methodology - Software Engineering
Agile Methodology - Software EngineeringPurvik Rana
 

Tendances (20)

Agile Methodology
Agile MethodologyAgile Methodology
Agile Methodology
 
What is agile model
What is agile modelWhat is agile model
What is agile model
 
The V Model
The V ModelThe V Model
The V Model
 
What is Agile Methodology?
What is Agile Methodology?What is Agile Methodology?
What is Agile Methodology?
 
Incremental model presentation
Incremental model presentationIncremental model presentation
Incremental model presentation
 
SDLC Model (Waterfall,Iterative Waterfall,Spiral)
SDLC Model (Waterfall,Iterative Waterfall,Spiral)SDLC Model (Waterfall,Iterative Waterfall,Spiral)
SDLC Model (Waterfall,Iterative Waterfall,Spiral)
 
Rapid Application Development Model
Rapid Application Development ModelRapid Application Development Model
Rapid Application Development Model
 
What is agile model?Working of agile model
What is agile model?Working of agile modelWhat is agile model?Working of agile model
What is agile model?Working of agile model
 
Gathering requirements
Gathering requirementsGathering requirements
Gathering requirements
 
Chapter19 rapid application development
Chapter19 rapid application developmentChapter19 rapid application development
Chapter19 rapid application development
 
Introduction agile scrum methodology
Introduction agile scrum methodologyIntroduction agile scrum methodology
Introduction agile scrum methodology
 
Overview of Agile Methodology
Overview of Agile MethodologyOverview of Agile Methodology
Overview of Agile Methodology
 
V model presentation
V model presentationV model presentation
V model presentation
 
Rad model
Rad modelRad model
Rad model
 
Rapid application developmet
Rapid application developmetRapid application developmet
Rapid application developmet
 
Software Development Methodologies
Software Development MethodologiesSoftware Development Methodologies
Software Development Methodologies
 
Software project management
Software project managementSoftware project management
Software project management
 
Ch 2 what is software quality
Ch 2 what is software qualityCh 2 what is software quality
Ch 2 what is software quality
 
Agile software development
Agile software developmentAgile software development
Agile software development
 
Agile Methodology - Software Engineering
Agile Methodology - Software EngineeringAgile Methodology - Software Engineering
Agile Methodology - Software Engineering
 

En vedette

Being Agile With Documentation
Being Agile With DocumentationBeing Agile With Documentation
Being Agile With DocumentationSusan Patch
 
Introduction to agile documentation
Introduction to agile documentationIntroduction to agile documentation
Introduction to agile documentationDaniel Grycman
 
Today’s Agile Documentation
Today’s Agile DocumentationToday’s Agile Documentation
Today’s Agile DocumentationMegan Leney
 
What is 'Just Enough' Documentation in Agile?
What is 'Just Enough' Documentation in Agile?What is 'Just Enough' Documentation in Agile?
What is 'Just Enough' Documentation in Agile?Sally Elatta
 
5. The Software Development Process - Documentation
5. The Software Development Process - Documentation5. The Software Development Process - Documentation
5. The Software Development Process - DocumentationForrester High School
 
6 basic steps of software development process
6 basic steps of software development process6 basic steps of software development process
6 basic steps of software development processRiant Soft
 
Documentation for Program Comprehension in Agile Software Development
Documentation for Program Comprehension in Agile Software DevelopmentDocumentation for Program Comprehension in Agile Software Development
Documentation for Program Comprehension in Agile Software DevelopmentFabian Kiss
 
Agile Software Development Overview
Agile Software Development OverviewAgile Software Development Overview
Agile Software Development OverviewStewart Rogers
 
Checklist for Agile Technical Writer
Checklist for Agile Technical WriterChecklist for Agile Technical Writer
Checklist for Agile Technical WriterSudhir Subudhi
 
Automation testing strategy, approach & planning
Automation testing  strategy, approach & planningAutomation testing  strategy, approach & planning
Automation testing strategy, approach & planningSivaprasanthRentala1975
 
Software cost estimation project
Software  cost estimation projectSoftware  cost estimation project
Software cost estimation projectShashank Puppala
 
Adapting to Agile Development for Software Documentation
Adapting to Agile Development for Software DocumentationAdapting to Agile Development for Software Documentation
Adapting to Agile Development for Software DocumentationZohra Iqbal Mutabanna
 
Test Automation Framework Designs
Test Automation Framework DesignsTest Automation Framework Designs
Test Automation Framework DesignsSauce Labs
 
Agile documentation
Agile documentationAgile documentation
Agile documentationAteeq Khaliq
 
It Project Workflow Document
It Project Workflow DocumentIt Project Workflow Document
It Project Workflow Documentcacmk5
 
INSIGHT Business Solutions
INSIGHT Business Solutions INSIGHT Business Solutions
INSIGHT Business Solutions Mitri J. Muna
 
Believe In Story - The Power of Content Creation Management
Believe In Story - The Power of Content Creation ManagementBelieve In Story - The Power of Content Creation Management
Believe In Story - The Power of Content Creation ManagementThe Content Advisory
 
2017 Volvo S60 Brochure | Orange County Volvo
2017 Volvo S60 Brochure | Orange County Volvo2017 Volvo S60 Brochure | Orange County Volvo
2017 Volvo S60 Brochure | Orange County VolvoVolvo Cars Mission Viejo
 

En vedette (19)

Being Agile With Documentation
Being Agile With DocumentationBeing Agile With Documentation
Being Agile With Documentation
 
Introduction to agile documentation
Introduction to agile documentationIntroduction to agile documentation
Introduction to agile documentation
 
Today’s Agile Documentation
Today’s Agile DocumentationToday’s Agile Documentation
Today’s Agile Documentation
 
What is 'Just Enough' Documentation in Agile?
What is 'Just Enough' Documentation in Agile?What is 'Just Enough' Documentation in Agile?
What is 'Just Enough' Documentation in Agile?
 
Software documentation
Software documentationSoftware documentation
Software documentation
 
5. The Software Development Process - Documentation
5. The Software Development Process - Documentation5. The Software Development Process - Documentation
5. The Software Development Process - Documentation
 
6 basic steps of software development process
6 basic steps of software development process6 basic steps of software development process
6 basic steps of software development process
 
Documentation for Program Comprehension in Agile Software Development
Documentation for Program Comprehension in Agile Software DevelopmentDocumentation for Program Comprehension in Agile Software Development
Documentation for Program Comprehension in Agile Software Development
 
Agile Software Development Overview
Agile Software Development OverviewAgile Software Development Overview
Agile Software Development Overview
 
Checklist for Agile Technical Writer
Checklist for Agile Technical WriterChecklist for Agile Technical Writer
Checklist for Agile Technical Writer
 
Automation testing strategy, approach & planning
Automation testing  strategy, approach & planningAutomation testing  strategy, approach & planning
Automation testing strategy, approach & planning
 
Software cost estimation project
Software  cost estimation projectSoftware  cost estimation project
Software cost estimation project
 
Adapting to Agile Development for Software Documentation
Adapting to Agile Development for Software DocumentationAdapting to Agile Development for Software Documentation
Adapting to Agile Development for Software Documentation
 
Test Automation Framework Designs
Test Automation Framework DesignsTest Automation Framework Designs
Test Automation Framework Designs
 
Agile documentation
Agile documentationAgile documentation
Agile documentation
 
It Project Workflow Document
It Project Workflow DocumentIt Project Workflow Document
It Project Workflow Document
 
INSIGHT Business Solutions
INSIGHT Business Solutions INSIGHT Business Solutions
INSIGHT Business Solutions
 
Believe In Story - The Power of Content Creation Management
Believe In Story - The Power of Content Creation ManagementBelieve In Story - The Power of Content Creation Management
Believe In Story - The Power of Content Creation Management
 
2017 Volvo S60 Brochure | Orange County Volvo
2017 Volvo S60 Brochure | Orange County Volvo2017 Volvo S60 Brochure | Orange County Volvo
2017 Volvo S60 Brochure | Orange County Volvo
 

Similaire à Documentation in the agile software development process

Avoiding The Knowledge Transfer Bottleneck
Avoiding The Knowledge Transfer BottleneckAvoiding The Knowledge Transfer Bottleneck
Avoiding The Knowledge Transfer Bottleneckstevebockman
 
Software Craftsmanship - JAX London 2011
Software Craftsmanship - JAX London 2011Software Craftsmanship - JAX London 2011
Software Craftsmanship - JAX London 2011Sandro Mancuso
 
An Introduction to Agile Software Development
An Introduction to Agile Software DevelopmentAn Introduction to Agile Software Development
An Introduction to Agile Software DevelopmentSerena Software
 
Adapting usability for agile ucd fer
Adapting usability for agile ucd ferAdapting usability for agile ucd fer
Adapting usability for agile ucd ferFer O'Neil
 
Being Agile in project management
Being Agile in project managementBeing Agile in project management
Being Agile in project managementChris Mitchell
 
Postcards From The Agile Frontier Final
Postcards From The Agile Frontier FinalPostcards From The Agile Frontier Final
Postcards From The Agile Frontier FinalElena Yatzeck
 
Opps approch of software development
Opps approch of software developmentOpps approch of software development
Opps approch of software developmentRaja Babu
 
Una decada de metodologias agiles
Una decada de metodologias agilesUna decada de metodologias agiles
Una decada de metodologias agilesoscar-esoinosa
 
Der pathologische Programmierer
Der pathologische ProgrammiererDer pathologische Programmierer
Der pathologische ProgrammiererJens Himmelreich
 
Agile Software Architecture
Agile Software ArchitectureAgile Software Architecture
Agile Software ArchitectureChris F Carroll
 
Workshop: Data Visualization for Corpus Linguistics via Shiny Framework
Workshop: Data Visualization for Corpus Linguistics via Shiny FrameworkWorkshop: Data Visualization for Corpus Linguistics via Shiny Framework
Workshop: Data Visualization for Corpus Linguistics via Shiny FrameworkOlga Scrivner
 
Adaptive Products: Designing for evolution through use
Adaptive Products: Designing for evolution through useAdaptive Products: Designing for evolution through use
Adaptive Products: Designing for evolution through useSimon King
 
Software Craftsmanship - Sandro Mancuso - BCS Agile Methods SG
Software Craftsmanship - Sandro Mancuso - BCS Agile Methods SGSoftware Craftsmanship - Sandro Mancuso - BCS Agile Methods SG
Software Craftsmanship - Sandro Mancuso - BCS Agile Methods SGJose Casal-Gimenez FBCS CITP
 
Software Craftsmanship
Software CraftsmanshipSoftware Craftsmanship
Software CraftsmanshipSandro Mancuso
 

Similaire à Documentation in the agile software development process (20)

Avoiding The Knowledge Transfer Bottleneck
Avoiding The Knowledge Transfer BottleneckAvoiding The Knowledge Transfer Bottleneck
Avoiding The Knowledge Transfer Bottleneck
 
oXabcaARRAAKALSL.docx
oXabcaARRAAKALSL.docxoXabcaARRAAKALSL.docx
oXabcaARRAAKALSL.docx
 
Software Craftsmanship - JAX London 2011
Software Craftsmanship - JAX London 2011Software Craftsmanship - JAX London 2011
Software Craftsmanship - JAX London 2011
 
An Introduction to Agile Software Development
An Introduction to Agile Software DevelopmentAn Introduction to Agile Software Development
An Introduction to Agile Software Development
 
7 Myths of Agile Development
7 Myths of Agile Development7 Myths of Agile Development
7 Myths of Agile Development
 
Adapting usability for agile ucd fer
Adapting usability for agile ucd ferAdapting usability for agile ucd fer
Adapting usability for agile ucd fer
 
Unit1
Unit1Unit1
Unit1
 
Being Agile in project management
Being Agile in project managementBeing Agile in project management
Being Agile in project management
 
Postcards From The Agile Frontier Final
Postcards From The Agile Frontier FinalPostcards From The Agile Frontier Final
Postcards From The Agile Frontier Final
 
Opps approch of software development
Opps approch of software developmentOpps approch of software development
Opps approch of software development
 
Una decada de metodologias agiles
Una decada de metodologias agilesUna decada de metodologias agiles
Una decada de metodologias agiles
 
What is Agile Development?
What is Agile Development?What is Agile Development?
What is Agile Development?
 
Der pathologische Programmierer
Der pathologische ProgrammiererDer pathologische Programmierer
Der pathologische Programmierer
 
Agile Software Architecture
Agile Software ArchitectureAgile Software Architecture
Agile Software Architecture
 
Workshop: Data Visualization for Corpus Linguistics via Shiny Framework
Workshop: Data Visualization for Corpus Linguistics via Shiny FrameworkWorkshop: Data Visualization for Corpus Linguistics via Shiny Framework
Workshop: Data Visualization for Corpus Linguistics via Shiny Framework
 
Adaptive Products: Designing for evolution through use
Adaptive Products: Designing for evolution through useAdaptive Products: Designing for evolution through use
Adaptive Products: Designing for evolution through use
 
Software Craftsmanship - Sandro Mancuso - BCS Agile Methods SG
Software Craftsmanship - Sandro Mancuso - BCS Agile Methods SGSoftware Craftsmanship - Sandro Mancuso - BCS Agile Methods SG
Software Craftsmanship - Sandro Mancuso - BCS Agile Methods SG
 
Software Craftsmanship
Software CraftsmanshipSoftware Craftsmanship
Software Craftsmanship
 
Nonsoftwareoss
NonsoftwareossNonsoftwareoss
Nonsoftwareoss
 
Lo 04
Lo 04Lo 04
Lo 04
 

Plus de Fabian Kiss

#noprojects (digest version)
#noprojects (digest version)#noprojects (digest version)
#noprojects (digest version)Fabian Kiss
 
#noprojects (full version)
#noprojects (full version)#noprojects (full version)
#noprojects (full version)Fabian Kiss
 
Relatives Schätzen - SwissICT Agile Breakfast Bern
Relatives Schätzen - SwissICT Agile Breakfast BernRelatives Schätzen - SwissICT Agile Breakfast Bern
Relatives Schätzen - SwissICT Agile Breakfast BernFabian Kiss
 
BDD in open source projects - Is it really beneficial?
BDD in open source projects - Is it really beneficial?BDD in open source projects - Is it really beneficial?
BDD in open source projects - Is it really beneficial?Fabian Kiss
 
Collocation in Distributed Scrum Teams - Lessons Learned
Collocation in Distributed Scrum Teams - Lessons LearnedCollocation in Distributed Scrum Teams - Lessons Learned
Collocation in Distributed Scrum Teams - Lessons LearnedFabian Kiss
 
Web Acceptance Testing with Behat
Web Acceptance Testing with BehatWeb Acceptance Testing with Behat
Web Acceptance Testing with BehatFabian Kiss
 
The concept of Behavior-Driven Development
The concept of Behavior-Driven DevelopmentThe concept of Behavior-Driven Development
The concept of Behavior-Driven DevelopmentFabian Kiss
 

Plus de Fabian Kiss (7)

#noprojects (digest version)
#noprojects (digest version)#noprojects (digest version)
#noprojects (digest version)
 
#noprojects (full version)
#noprojects (full version)#noprojects (full version)
#noprojects (full version)
 
Relatives Schätzen - SwissICT Agile Breakfast Bern
Relatives Schätzen - SwissICT Agile Breakfast BernRelatives Schätzen - SwissICT Agile Breakfast Bern
Relatives Schätzen - SwissICT Agile Breakfast Bern
 
BDD in open source projects - Is it really beneficial?
BDD in open source projects - Is it really beneficial?BDD in open source projects - Is it really beneficial?
BDD in open source projects - Is it really beneficial?
 
Collocation in Distributed Scrum Teams - Lessons Learned
Collocation in Distributed Scrum Teams - Lessons LearnedCollocation in Distributed Scrum Teams - Lessons Learned
Collocation in Distributed Scrum Teams - Lessons Learned
 
Web Acceptance Testing with Behat
Web Acceptance Testing with BehatWeb Acceptance Testing with Behat
Web Acceptance Testing with Behat
 
The concept of Behavior-Driven Development
The concept of Behavior-Driven DevelopmentThe concept of Behavior-Driven Development
The concept of Behavior-Driven Development
 

Dernier

How to Troubleshoot Apps for the Modern Connected Worker
How to Troubleshoot Apps for the Modern Connected WorkerHow to Troubleshoot Apps for the Modern Connected Worker
How to Troubleshoot Apps for the Modern Connected WorkerThousandEyes
 
Boost PC performance: How more available memory can improve productivity
Boost PC performance: How more available memory can improve productivityBoost PC performance: How more available memory can improve productivity
Boost PC performance: How more available memory can improve productivityPrincipled Technologies
 
From Event to Action: Accelerate Your Decision Making with Real-Time Automation
From Event to Action: Accelerate Your Decision Making with Real-Time AutomationFrom Event to Action: Accelerate Your Decision Making with Real-Time Automation
From Event to Action: Accelerate Your Decision Making with Real-Time AutomationSafe Software
 
The 7 Things I Know About Cyber Security After 25 Years | April 2024
The 7 Things I Know About Cyber Security After 25 Years | April 2024The 7 Things I Know About Cyber Security After 25 Years | April 2024
The 7 Things I Know About Cyber Security After 25 Years | April 2024Rafal Los
 
08448380779 Call Girls In Friends Colony Women Seeking Men
08448380779 Call Girls In Friends Colony Women Seeking Men08448380779 Call Girls In Friends Colony Women Seeking Men
08448380779 Call Girls In Friends Colony Women Seeking MenDelhi Call girls
 
Real Time Object Detection Using Open CV
Real Time Object Detection Using Open CVReal Time Object Detection Using Open CV
Real Time Object Detection Using Open CVKhem
 
04-2024-HHUG-Sales-and-Marketing-Alignment.pptx
04-2024-HHUG-Sales-and-Marketing-Alignment.pptx04-2024-HHUG-Sales-and-Marketing-Alignment.pptx
04-2024-HHUG-Sales-and-Marketing-Alignment.pptxHampshireHUG
 
Automating Google Workspace (GWS) & more with Apps Script
Automating Google Workspace (GWS) & more with Apps ScriptAutomating Google Workspace (GWS) & more with Apps Script
Automating Google Workspace (GWS) & more with Apps Scriptwesley chun
 
Slack Application Development 101 Slides
Slack Application Development 101 SlidesSlack Application Development 101 Slides
Slack Application Development 101 Slidespraypatel2
 
Boost Fertility New Invention Ups Success Rates.pdf
Boost Fertility New Invention Ups Success Rates.pdfBoost Fertility New Invention Ups Success Rates.pdf
Boost Fertility New Invention Ups Success Rates.pdfsudhanshuwaghmare1
 
[2024]Digital Global Overview Report 2024 Meltwater.pdf
[2024]Digital Global Overview Report 2024 Meltwater.pdf[2024]Digital Global Overview Report 2024 Meltwater.pdf
[2024]Digital Global Overview Report 2024 Meltwater.pdfhans926745
 
08448380779 Call Girls In Greater Kailash - I Women Seeking Men
08448380779 Call Girls In Greater Kailash - I Women Seeking Men08448380779 Call Girls In Greater Kailash - I Women Seeking Men
08448380779 Call Girls In Greater Kailash - I Women Seeking MenDelhi Call girls
 
Strategies for Unlocking Knowledge Management in Microsoft 365 in the Copilot...
Strategies for Unlocking Knowledge Management in Microsoft 365 in the Copilot...Strategies for Unlocking Knowledge Management in Microsoft 365 in the Copilot...
Strategies for Unlocking Knowledge Management in Microsoft 365 in the Copilot...Drew Madelung
 
Advantages of Hiring UIUX Design Service Providers for Your Business
Advantages of Hiring UIUX Design Service Providers for Your BusinessAdvantages of Hiring UIUX Design Service Providers for Your Business
Advantages of Hiring UIUX Design Service Providers for Your BusinessPixlogix Infotech
 
Scaling API-first – The story of a global engineering organization
Scaling API-first – The story of a global engineering organizationScaling API-first – The story of a global engineering organization
Scaling API-first – The story of a global engineering organizationRadu Cotescu
 
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...apidays
 
Axa Assurance Maroc - Insurer Innovation Award 2024
Axa Assurance Maroc - Insurer Innovation Award 2024Axa Assurance Maroc - Insurer Innovation Award 2024
Axa Assurance Maroc - Insurer Innovation Award 2024The Digital Insurer
 
08448380779 Call Girls In Civil Lines Women Seeking Men
08448380779 Call Girls In Civil Lines Women Seeking Men08448380779 Call Girls In Civil Lines Women Seeking Men
08448380779 Call Girls In Civil Lines Women Seeking MenDelhi Call girls
 
Artificial Intelligence: Facts and Myths
Artificial Intelligence: Facts and MythsArtificial Intelligence: Facts and Myths
Artificial Intelligence: Facts and MythsJoaquim Jorge
 
Data Cloud, More than a CDP by Matt Robison
Data Cloud, More than a CDP by Matt RobisonData Cloud, More than a CDP by Matt Robison
Data Cloud, More than a CDP by Matt RobisonAnna Loughnan Colquhoun
 

Dernier (20)

How to Troubleshoot Apps for the Modern Connected Worker
How to Troubleshoot Apps for the Modern Connected WorkerHow to Troubleshoot Apps for the Modern Connected Worker
How to Troubleshoot Apps for the Modern Connected Worker
 
Boost PC performance: How more available memory can improve productivity
Boost PC performance: How more available memory can improve productivityBoost PC performance: How more available memory can improve productivity
Boost PC performance: How more available memory can improve productivity
 
From Event to Action: Accelerate Your Decision Making with Real-Time Automation
From Event to Action: Accelerate Your Decision Making with Real-Time AutomationFrom Event to Action: Accelerate Your Decision Making with Real-Time Automation
From Event to Action: Accelerate Your Decision Making with Real-Time Automation
 
The 7 Things I Know About Cyber Security After 25 Years | April 2024
The 7 Things I Know About Cyber Security After 25 Years | April 2024The 7 Things I Know About Cyber Security After 25 Years | April 2024
The 7 Things I Know About Cyber Security After 25 Years | April 2024
 
08448380779 Call Girls In Friends Colony Women Seeking Men
08448380779 Call Girls In Friends Colony Women Seeking Men08448380779 Call Girls In Friends Colony Women Seeking Men
08448380779 Call Girls In Friends Colony Women Seeking Men
 
Real Time Object Detection Using Open CV
Real Time Object Detection Using Open CVReal Time Object Detection Using Open CV
Real Time Object Detection Using Open CV
 
04-2024-HHUG-Sales-and-Marketing-Alignment.pptx
04-2024-HHUG-Sales-and-Marketing-Alignment.pptx04-2024-HHUG-Sales-and-Marketing-Alignment.pptx
04-2024-HHUG-Sales-and-Marketing-Alignment.pptx
 
Automating Google Workspace (GWS) & more with Apps Script
Automating Google Workspace (GWS) & more with Apps ScriptAutomating Google Workspace (GWS) & more with Apps Script
Automating Google Workspace (GWS) & more with Apps Script
 
Slack Application Development 101 Slides
Slack Application Development 101 SlidesSlack Application Development 101 Slides
Slack Application Development 101 Slides
 
Boost Fertility New Invention Ups Success Rates.pdf
Boost Fertility New Invention Ups Success Rates.pdfBoost Fertility New Invention Ups Success Rates.pdf
Boost Fertility New Invention Ups Success Rates.pdf
 
[2024]Digital Global Overview Report 2024 Meltwater.pdf
[2024]Digital Global Overview Report 2024 Meltwater.pdf[2024]Digital Global Overview Report 2024 Meltwater.pdf
[2024]Digital Global Overview Report 2024 Meltwater.pdf
 
08448380779 Call Girls In Greater Kailash - I Women Seeking Men
08448380779 Call Girls In Greater Kailash - I Women Seeking Men08448380779 Call Girls In Greater Kailash - I Women Seeking Men
08448380779 Call Girls In Greater Kailash - I Women Seeking Men
 
Strategies for Unlocking Knowledge Management in Microsoft 365 in the Copilot...
Strategies for Unlocking Knowledge Management in Microsoft 365 in the Copilot...Strategies for Unlocking Knowledge Management in Microsoft 365 in the Copilot...
Strategies for Unlocking Knowledge Management in Microsoft 365 in the Copilot...
 
Advantages of Hiring UIUX Design Service Providers for Your Business
Advantages of Hiring UIUX Design Service Providers for Your BusinessAdvantages of Hiring UIUX Design Service Providers for Your Business
Advantages of Hiring UIUX Design Service Providers for Your Business
 
Scaling API-first – The story of a global engineering organization
Scaling API-first – The story of a global engineering organizationScaling API-first – The story of a global engineering organization
Scaling API-first – The story of a global engineering organization
 
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...
Apidays Singapore 2024 - Building Digital Trust in a Digital Economy by Veron...
 
Axa Assurance Maroc - Insurer Innovation Award 2024
Axa Assurance Maroc - Insurer Innovation Award 2024Axa Assurance Maroc - Insurer Innovation Award 2024
Axa Assurance Maroc - Insurer Innovation Award 2024
 
08448380779 Call Girls In Civil Lines Women Seeking Men
08448380779 Call Girls In Civil Lines Women Seeking Men08448380779 Call Girls In Civil Lines Women Seeking Men
08448380779 Call Girls In Civil Lines Women Seeking Men
 
Artificial Intelligence: Facts and Myths
Artificial Intelligence: Facts and MythsArtificial Intelligence: Facts and Myths
Artificial Intelligence: Facts and Myths
 
Data Cloud, More than a CDP by Matt Robison
Data Cloud, More than a CDP by Matt RobisonData Cloud, More than a CDP by Matt Robison
Data Cloud, More than a CDP by Matt Robison
 

Documentation in the agile software development process

  • 1. Fabian Kiss Sep 2011 Scrum User Group Lake Constance
  • 2. DO AGILISTES NEED DOCUMENTATION?
  • 3. THE MANIFESTO ON DOCUMENTATION Manifesto for Agile Software Development We are uncovering better ways of developing software by doing it and helping others do it. Through this work we have come to value: Individuals and interactions over processes and tools Working software over comprehensive documentation Customer collaboration over contract negotiation Responding to change over following a plan That is, while there is value in the items on the right, we value the items on the left more.
  • 4. THE MANIFESTO ON DOCUMENTATION Manifesto for Agile Software Development We are uncovering better ways of developing software by doing it and helping others do it. Through this work we have come to value: Individuals and interactions over processes and tools Working software over comprehensive documentation Customer collaboration over contract negotiation Responding to change over following a plan That is, while there is value in the items on the right, we value the items on the left more.
  • 5. LET'S HAVE A CLOSER LOOK AT SOME DEFINITIONS
  • 6. AGILE PROCESS  Definition by values and practices (Manifesto & beyond)
  • 7. AGILE PROCESS Agile Software Development Poster by VersionOne, Inc., 2011, licensed under the CC BY-SA 3.0
  • 8. AGILE PROCESS  Definition by values and practices (Manifesto & beyond)  Definition by “SDLC coverage”
  • 9. AGILE PROCESS From Agile Software Development Methods: Review and Analysis by Abrahamsson, P., Salo, O., Ronkainen, J., & Warsta, J., 2002, licensed under the CC BY-SA 3.0
  • 10. AGILE PROCESS  Definition by values and practices (Manifesto & beyond)  Definition by “SDLC coverage”  Definition by ... There is a common understanding of what an agile software development process is
  • 11. DOCUMENTATION Virtually no definition of documentation (in respect of software development)
  • 12. DOCUMENTATION Virtually no definition of documentation (in respect of software development)  From the developer's perspective: source code documentation  From the project stakeholder's perspective: system documentation
  • 13. DOCUMENTATION Virtually no definition of documentation (in respect of software development)  From the developer's perspective: source code documentation  From the project stakeholder's perspective: system documentation  More general: software documentation  Umbrella term for any documentation related to a software product
  • 14. DOCUMENTATION Virtually no definition of documentation (in respect of software development)  From the developer's perspective: source code documentation  From the project stakeholder's perspective: system documentation  More general: software documentation  Umbrella term for any documentation related to a software product People think of different things when referring to documentation
  • 15.
  • 16. DOCUMENTATION Proposal for an initial classification: Documentation dealing with properties of a software product ...  ... during its development  ... after its completion
  • 17. BOOKS ABOUT AGILE DOCUMENTATION Picture by Jeremy Nelson, licensed under the CC BY-NC-SA 2.0
  • 18. S.W. AMBLER: 'AGILE MODELING' Scott W. Ambler Agile Modeling: Effective Practices for eXtreme Programming and the Unified Process Wiley 2002
  • 19. S.W. AMBLER: 'AGILE MODELING' Chapter about agile documentation (www.agilemodeling.com holds a more recent version of it) Values, principles and practices for Agile Modeling adopted from XP/Agile values, principles and practices
  • 20. S.W. AMBLER: 'AGILE MODELING' One of his values in the context of documentation: “The fundamental issue is communication, not documentation.” From Agile/Lean Documentation: Strategies for Agile Software Development by Scott W. Ambler, http://www.agilemodeling.com/essays/agileDocumentation.htm#CriticalPoints
  • 21. S.W. AMBLER: 'AGILE MODELING' One of his principles in the context of documentation: “Travel Light. Every artifact that you create, and then decide to keep, will need to be maintained over time.” From Agile Modeling (AM) Principles v2 by Scott W. Ambler, http://www.agilemodeling.com/principles.htm#TravelLight
  • 22. S.W. AMBLER: 'AGILE MODELING' Two of his practices in the context of documentation: “Executable specifications, for example [...] a developer test-suite [...]. Because these artifacts add value there is a significantly greater chance that developers will keep them up-to-date.” From Agile/Lean Documentation: Strategies for Agile Software Development by Scott W. Ambler, http://www.agilemodeling.com/essays/agileDocumentation.htm#IssuesWithDocumentation
  • 23. S.W. AMBLER: 'AGILE MODELING' Two of his practices in the context of documentation: “Executable specifications, for example [...] a developer test-suite [...]. Because these artifacts add value there is a significantly greater chance that developers will keep them up-to-date.” From Agile/Lean Documentation: Strategies for Agile Software Development by Scott W. Ambler, http://www.agilemodeling.com/essays/agileDocumentation.htm#IssuesWithDocumentation "Document stable concepts, not speculative concepts, and thereby document as late as possible in the life cycle." From Agile/Lean Documentation: Strategies for Agile Software Development by Scott W. Ambler, http://www.agilemodeling.com/essays/agileDocumentation.htm#WhenToCreateDocumentation
  • 24. S.W. AMBLER: 'AGILE MODELING' Two of his practices in the context of documentation: “Executable specifications, for example [...] a developer test-suite [...]. Because these artifacts add value there is a significantly greater chance that developers will keep them up-to-date.” From Agile/Lean Documentation: Strategies for Agile Software Development by Scott W. Ambler, http://www.agilemodeling.com/essays/agileDocumentation.htm#IssuesWithDocumentation "Document stable concepts, not speculative concepts, and thereby document as late as possible in the life cycle." t From Agile/Lean Documentation: Strategies for Agile Software Development by Scott W. Ambler, whe n to documen http://www.agilemodeling.com/essays/agileDocumentation.htm#WhenToCreateDocumentation
  • 26. S.W. AMBLER: 'AGILE MODELING' Strongly influenced by Agile Modeling (the author's major interest)  AM as a certain agile methodology  AMDD as a certain software development approach
  • 27. S.W. AMBLER: 'AGILE MODELING' Strongly influenced by Agile Modeling (the author's major interest)  AM as a certain agile methodology  AMDD as a certain software development approach Limits generality
  • 28. A. RÜPING: 'AGILE DOCUMENTATION' Andreas Rüping Agile Documentation: A Pattern Guide to Producing Lightweight Documents for Software Projects Wiley 2003 (It's a app comple a can rently tely dif not t f fr o n affo he pub erent b rd d l t co v er esig isher s ook, fo r ning imp each a un l y of i t ique s bo oks)
  • 29. A. RÜPING: 'AGILE DOCUMENTATION' Patterns as descriptions of solutions to certain documentation issues in agile software projects, divided into five categories: 1. Finding the Right Topics 2. Structuring Individual Documents 3. Layout and Typography 4. Infrastructure and Technical Organisation 5. Management and Quality Assurance
  • 30. A. RÜPING: 'AGILE DOCUMENTATION' Examples (“Pattern Thumbnails”): From Agile Documentation: A Pattern Guide to Producing Lightweight Documents for Software Projects by Andreas Rüping, 2003, Wiley, p. 198
  • 31. A. RÜPING: 'AGILE DOCUMENTATION' Examples (“Pattern Thumbnails”): From Agile Documentation: A Pattern Guide to Producing Lightweight Documents for Software Projects by Andreas Rüping, 2003, Wiley, p. 198 From Agile Documentation: A Pattern Guide to Producing Lightweight Documents for Software Projects by Andreas Rüping, 2003, Wiley, p. 201
  • 32. A. RÜPING: 'AGILE DOCUMENTATION' Furthermore... “Different people grasp information at different speeds. […] Documents […] allow people to read at their own pace.” From Agile Documentation: A Pattern Guide to Producing Lightweight Documents for Software Projects by Andreas Rüping, 2003, Wiley, p. 20
  • 33. A. RÜPING: 'AGILE DOCUMENTATION' Furthermore... “Different people grasp information at different speeds. […] Documents […] allow people to read at their own pace.” From Agile Documentation: A Pattern Guide to Producing Lightweight Documents for Software Projects by Andreas Rüping, 2003, Wiley, p. 20 agile principle s' relation to ind ividuals
  • 35. A. RÜPING: 'AGILE DOCUMENTATION' Obviously the patterns are more or less specific to agile software development
  • 36. A. RÜPING: 'AGILE DOCUMENTATION' Obviously the patterns are more or less specific to agile software development Some problems unique for documentation in agile software development might not be addressed at all
  • 37. Picture by César Astudillo, licensed under the CC BY-NC 2.0
  • 38. Documentation itself is simply a too broad topic ...
  • 39. Documentation itself is simply a too broad topic ... … even agile documentation is still something very unspecific
  • 40. SOME OPTIMISM PLEASE! Picture by LawPrieR, licensed under the CC BY-NC 2.0
  • 41. Before considering (or developing) any practices, patterns or other forms of advice for agile documentation, we should further delimit the scope!
  • 42. Before considering (or developing) any practices, patterns or other forms of advice for agile documentation, we should further delimit the scope!
  • 43. Before considering (or developing) any practices, patterns or other forms of advice for agile documentation, we should further delimit the scope!  Documentation for during/after development
  • 44. Before considering (or developing) any practices, patterns or other forms of advice for agile documentation, we should further delimit the scope! ✔ Documentation for during/after development  Who documents for whom?
  • 45. Before considering (or developing) any practices, patterns or other forms of advice for agile documentation, we should further delimit the scope! ✔ Documentation for during/after development  Who documents for whom?  Documenting for what specific purpose?
  • 46. Before considering (or developing) any practices, patterns or other forms of advice for agile documentation, we should further delimit the scope! ✔ Documentation for during/after development  Who documents for whom?  Documenting for what specific purpose?  ...