SlideShare une entreprise Scribd logo
1  sur  33
Technical Writing in an Agile
Development Environment
A Writer’s Perspective
2
Objectives
 Learn to apply useful principles from agile
methodologies
 Highlight the features common to agile
development processes
 Understand user stories and learn to translate
user stories into task-oriented topics
 Learn to use various collaboration tools that can
facilitate writing
 Learn to be adaptive
3
The Agile Parable
A pig and a chicken are walking down a road. The
chicken looks at the pig and says, "Hey, why
don't we open a restaurant?" The pig looks back
at the chicken and says, "Good idea, what do
you want to call it?"
The chicken thinks about it and says, "Why don't
we call it 'Ham and Eggs'?"
"I don't think so," says the pig, "I'd be committed
but you'd only be involved.”
4
Who’s Who in Agile
5
Scrum Origins
 The new product development game - Tekeuchi
and Nonaka
 A group of 17 individuals got together in
Colorado in 2001 to form the Agile manifesto.
 Jeff Sutherland and Ken Schwaber
 Initial definitions of Scrum at OOPSLA 96
 Not just for trivial projects
 FDA-approved, life-critical software for x-rays and MRIs
6
The Agile Manifesto
Over
7
Phases of Scrum– From Concept to
Execution
8
The Scrum Development Process
Daily Scrum
•Hosted by ScrumMaster
•Attended by all, but Stakeholders
don’t speak
•Same time every day
•Answer: 1) What did you do
yesterday? 2) What will you do
today? 3) What’s in your way?
•Team updates Sprint Backlog;
Scrum Master updates Blocks List
POPO
Product Owner:
Sets priorities
SMSM
ScrumMaster:
Manages process,
removes blocks
TT
Team (Pigs):
Develops
product
SHSH
Stakeholders
(Chickens):
observe & advise
Key Artifacts
Product Backlog
•List of requirements & issues
•Owned by Product Owner
•Anybody can add to it
•Only Product Owner prioritizes
Product Backlog
•List of requirements & issues
•Owned by Product Owner
•Anybody can add to it
•Only Product Owner prioritizes
Sprint Goal
•One-sentence summary
•Declared by Product Owner
•Accepted by team
Sprint Goal
•One-sentence summary
•Declared by Product Owner
•Accepted by team
Sprint Backlog
•List of tasks
•Owned by team
•Only team modifies it
Sprint Backlog
•List of tasks
•Owned by team
•Only team modifies it
Blocks List
•List of blocks & unmade
decisions
•Owned by ScrumMaster
•Updated daily
Blocks List
•List of blocks & unmade
decisions
•Owned by ScrumMaster
•Updated daily
Increment
•Version of the product
•Shippable functionality (tested,
documented, etc.)
Increment
•Version of the product
•Shippable functionality (tested,
documented, etc.)
Key Meetings
Sprint Planning Meeting
•Hosted by ScrumMaster; ½-1 day
•In: Product Backlog, existing
product, business & technology
conditions
1. Select highest priority items in
Product Backlog; declare Sprint Goal
2. Team turns selected items into
Sprint Backlog
Out:: Sprint Goal, Sprint Backlog
Sprint Review Meeting
•Hosted by ScrumMaster
•Attended by all
•Informal, 4-hour, informational
•Team demos Increment
•All discuss
•Hold retrospective
•Announce next Sprint Planning
Meeting
Product
Backlog
Product
Backlog
Development Process
IncrementIncrement
Sprint Planning Meeting
Daily Scrum
Daily Work
Sprint
Goal
Sprint
Goal
Sprint
Backlog
Sprint
Backlog
Blocks
List
Blocks
List
ProductProduct
Sprint Review Meeting
Sprint:
15-30 days
each
Product
Backlog’
Product
Backlog’
Increment’Increment’
Copyright 2004, William C. Wake, William.Wake@acm.org, www.xp123.com
9
Agile System Development Lifecycle
10
Overlapping Development in Scrum
11
Waterfall vs. Agile
12
Making the Transition
 How can I adapt myself to Scrum?
13
Design Documents
 Moving from specs to user story documents
 Shorter, more fluid documents
 Allows for easier refinement and rework upon
customer feedback
 Helps the writers to not get bogged down in lengthy
specs
14
User Stories- What is it?
 A software system requirement
 Defines what is to be built
 Prioritized, make up the backlog
 Stories may be related together as “features” or
“themes”
15
User Stories
As a … < role> …
I want … <short description of feature> …
So that … <value or why need functionality>
…
Examples:
 As a sales manager I want to view the sales report so
that I can know the sales for this quarter.
 As a regular traveler I want my cell-phone to wake me
up at a set time so that I do not need to pack an alarm
clock.
16
Acceptance Criteria
A common acceptance criteria
template:
Given … <some initial context > …
When … <an event occurs> …
Then … <ensure some outcomes> …
Given my cell-phone is switched off when
the time for my alarm is reached then turn
the cell-phone on and sound the alarm.
17
Topic-Oriented Writing
18
Topic-Oriented Writing
 Authoring concise, self-contained units of
information about a specific topic
 Concept
 Task
 Reference
19
Using Minimalism
 Choose an action-oriented approach to your
documentation
 Promote learning by doing rather than by
reading
 Evaluate what to trim and why (‘Just enough’
documentation)
 Focus on troubleshooting advice
 Identify opportunities to replace text with
graphics
20
Benefits of Using Minimalism
 Pushes us to be more user-focused
 Makes us look out for redundant information
 Drives us to cut costs while delivering better
information
 Portrays us like we understood our role better
21
Collaborate
 Use a collaboration tool (e.g. wiki)
 Attend daily scrum meetings
 Be detailed and specific when you are seeking
information
22
Using Wikis
Image Copyright @ Atlassian
23
Best Practices for Wiki Implementation
24
Using Wikis as an Input for Docs
25
Backlog is Your Friend
 The Backlog in Scrum is the Technical Writer’s
best friend.
 Work with the dev team to understand the tasks
 You can re-plan a Sprint in the mid-Sprint
 Allocate some time in the Sprint for
maintenance and patches.
 Backlog is NOT DONE if the end-user
documentation is not complete
26
Document Reviews in Scrum
 Use drafts
 Write doc for a feature that is developed and
tested in the Sprint
 Have Dev/QA review the doc for technical
accuracy before closing the user story
 Make the required edits
 Publish IT
 Present the doc to the PO in the exit meeting
27
Before the Release
 Have a stabilization sprint for
the document cleanups,
versioning, and help
integration.
28
Vertical Doc Team Structure – Writer
Aligned to the Scrum Teams
Write
r
Product ABC Product XYZ Released products Legacy
Product
s
Feature A Feature
B
Feature
A
Feature
B
Feature
A
Feature B Bugs/
Minor
Fixes
Patche
s
Life
Support
Steve
Maria
Marc
29
Scrum in Action
30
The Benefits of Writing in an Agile
Environment
Questions?
32
Sources and Bibliography
 Agile Estimating and Planning, Mike Cohn, Prentice Hall, 2006.
 Agile Project Management with Scrum, Ken Schwaber, Microsoft Press,
2004.
 Writing Effective Use Cases, Alistair Cockburn, Addison Wesley, 2001.
 Agile Development: Challenges in Transforming Technical Communications
Departments, Mike Wethington.
 “An Overview of Scrum”, Mike Cohn,
http://www.mountaingoatsoftware.com/presentation/30-an-overview-of-scrum
, 2008
 “Writing End-User Documentation in an Agile Development Environment,”
Anne Gentle & Tana Berry,
http://justwriteclick.com/2007/07/02/writing-end-user-documentation-in-an-agile-de
, 2007.
Thank You

Contenu connexe

Tendances

Top 50 Product Owner Interview Question and Answers | Edureka
Top 50 Product Owner Interview Question and Answers | EdurekaTop 50 Product Owner Interview Question and Answers | Edureka
Top 50 Product Owner Interview Question and Answers | EdurekaEdureka!
 
Agile Scrum Presentation-Detailed
Agile Scrum Presentation-DetailedAgile Scrum Presentation-Detailed
Agile Scrum Presentation-DetailedPrashaanth T R
 
Case Study on agile scrum methodology on shopping cart
Case Study on agile scrum methodology on shopping cartCase Study on agile scrum methodology on shopping cart
Case Study on agile scrum methodology on shopping cartAbdullah Raza
 
Basic Scrum Framework
Basic Scrum FrameworkBasic Scrum Framework
Basic Scrum FrameworkNaresh Jain
 
Introduction To Scrum
Introduction To ScrumIntroduction To Scrum
Introduction To ScrumDave Neuman
 
PMP Chapter 6 of 6 closing process group (1- Process) (Based on PMBOK 6th ed...
PMP Chapter 6 of 6  closing process group (1- Process) (Based on PMBOK 6th ed...PMP Chapter 6 of 6  closing process group (1- Process) (Based on PMBOK 6th ed...
PMP Chapter 6 of 6 closing process group (1- Process) (Based on PMBOK 6th ed...Shamil Habet
 
Stop Starting Start Finishing
Stop Starting Start FinishingStop Starting Start Finishing
Stop Starting Start FinishingDashlane
 
Jira as a Project Management Tool
Jira as a Project Management ToolJira as a Project Management Tool
Jira as a Project Management ToolPaolo Mottadelli
 
Agile Methodology Assessment
Agile Methodology AssessmentAgile Methodology Assessment
Agile Methodology AssessmentSandy Lee
 
Introduction to JIRA
Introduction to JIRAIntroduction to JIRA
Introduction to JIRAguestb67fcdb
 
Introduction to Agile & Scrum
Introduction to Agile & ScrumIntroduction to Agile & Scrum
Introduction to Agile & ScrumHawkman Academy
 
Scrum 101: Introduction to Scrum
Scrum 101: Introduction to ScrumScrum 101: Introduction to Scrum
Scrum 101: Introduction to ScrumArrielle Mali
 
Waterfall vs Agile : A Beginner's Guide in Project Management
Waterfall vs Agile : A Beginner's Guide in Project ManagementWaterfall vs Agile : A Beginner's Guide in Project Management
Waterfall vs Agile : A Beginner's Guide in Project ManagementJonathan Donado
 

Tendances (20)

Top 50 Product Owner Interview Question and Answers | Edureka
Top 50 Product Owner Interview Question and Answers | EdurekaTop 50 Product Owner Interview Question and Answers | Edureka
Top 50 Product Owner Interview Question and Answers | Edureka
 
Agile Scrum Presentation-Detailed
Agile Scrum Presentation-DetailedAgile Scrum Presentation-Detailed
Agile Scrum Presentation-Detailed
 
Case Study on agile scrum methodology on shopping cart
Case Study on agile scrum methodology on shopping cartCase Study on agile scrum methodology on shopping cart
Case Study on agile scrum methodology on shopping cart
 
Basic Scrum Framework
Basic Scrum FrameworkBasic Scrum Framework
Basic Scrum Framework
 
What Is Agile Scrum
What Is Agile ScrumWhat Is Agile Scrum
What Is Agile Scrum
 
Introduction To Scrum
Introduction To ScrumIntroduction To Scrum
Introduction To Scrum
 
PMP Chapter 6 of 6 closing process group (1- Process) (Based on PMBOK 6th ed...
PMP Chapter 6 of 6  closing process group (1- Process) (Based on PMBOK 6th ed...PMP Chapter 6 of 6  closing process group (1- Process) (Based on PMBOK 6th ed...
PMP Chapter 6 of 6 closing process group (1- Process) (Based on PMBOK 6th ed...
 
Stop Starting Start Finishing
Stop Starting Start FinishingStop Starting Start Finishing
Stop Starting Start Finishing
 
Jira as a Project Management Tool
Jira as a Project Management ToolJira as a Project Management Tool
Jira as a Project Management Tool
 
Agile Methodology Assessment
Agile Methodology AssessmentAgile Methodology Assessment
Agile Methodology Assessment
 
Introduction to JIRA
Introduction to JIRAIntroduction to JIRA
Introduction to JIRA
 
Agile Scrum Methodology
Agile Scrum MethodologyAgile Scrum Methodology
Agile Scrum Methodology
 
Introduction to Agile & Scrum
Introduction to Agile & ScrumIntroduction to Agile & Scrum
Introduction to Agile & Scrum
 
Flutter
FlutterFlutter
Flutter
 
Scrum in an hour
Scrum in an hourScrum in an hour
Scrum in an hour
 
Scrum 101: Introduction to Scrum
Scrum 101: Introduction to ScrumScrum 101: Introduction to Scrum
Scrum 101: Introduction to Scrum
 
Waterfall vs Agile : A Beginner's Guide in Project Management
Waterfall vs Agile : A Beginner's Guide in Project ManagementWaterfall vs Agile : A Beginner's Guide in Project Management
Waterfall vs Agile : A Beginner's Guide in Project Management
 
What is Scrum?
What is Scrum?What is Scrum?
What is Scrum?
 
Scrum ceromonies
Scrum ceromoniesScrum ceromonies
Scrum ceromonies
 
Jira training
Jira trainingJira training
Jira training
 

En vedette

Requirements Craftsmanship 101 - Agile and Beyond 2015 Session
Requirements Craftsmanship 101 - Agile and Beyond 2015 SessionRequirements Craftsmanship 101 - Agile and Beyond 2015 Session
Requirements Craftsmanship 101 - Agile and Beyond 2015 SessionHolly Bielawa
 
An Agile Overview @ ShoreTel Sky
An Agile Overview @ ShoreTel SkyAn Agile Overview @ ShoreTel Sky
An Agile Overview @ ShoreTel Skygirabrent
 
Agile Development Overview
Agile Development OverviewAgile Development Overview
Agile Development Overviewguestb4c770
 
Tech Talk: Agile 101: Day in the Life of an Agile Team
Tech Talk: Agile 101: Day in the Life of an Agile TeamTech Talk: Agile 101: Day in the Life of an Agile Team
Tech Talk: Agile 101: Day in the Life of an Agile TeamCA Technologies
 
Agile 101
Agile 101Agile 101
Agile 101beLithe
 
CA Agile Requirements Designer 101 - an introduction to the general premise o...
CA Agile Requirements Designer 101 - an introduction to the general premise o...CA Agile Requirements Designer 101 - an introduction to the general premise o...
CA Agile Requirements Designer 101 - an introduction to the general premise o...CA Technologies
 
Agile vs Iterative vs Waterfall models
Agile vs Iterative vs Waterfall models Agile vs Iterative vs Waterfall models
Agile vs Iterative vs Waterfall models Marraju Bollapragada V
 
Tech Talk: Agile 101: You've Got Scrum Teams. So What?
Tech Talk: Agile 101: You've Got Scrum Teams. So What?Tech Talk: Agile 101: You've Got Scrum Teams. So What?
Tech Talk: Agile 101: You've Got Scrum Teams. So What?CA Technologies
 
Agile Software Development Overview
Agile Software Development OverviewAgile Software Development Overview
Agile Software Development OverviewStewart Rogers
 

En vedette (15)

Introduction to Agile
Introduction to AgileIntroduction to Agile
Introduction to Agile
 
Requirements Craftsmanship 101 - Agile and Beyond 2015 Session
Requirements Craftsmanship 101 - Agile and Beyond 2015 SessionRequirements Craftsmanship 101 - Agile and Beyond 2015 Session
Requirements Craftsmanship 101 - Agile and Beyond 2015 Session
 
Agile 101
Agile 101Agile 101
Agile 101
 
An Agile Overview @ ShoreTel Sky
An Agile Overview @ ShoreTel SkyAn Agile Overview @ ShoreTel Sky
An Agile Overview @ ShoreTel Sky
 
Agile Development Overview
Agile Development OverviewAgile Development Overview
Agile Development Overview
 
Why Agile?
Why Agile?Why Agile?
Why Agile?
 
Tech Talk: Agile 101: Day in the Life of an Agile Team
Tech Talk: Agile 101: Day in the Life of an Agile TeamTech Talk: Agile 101: Day in the Life of an Agile Team
Tech Talk: Agile 101: Day in the Life of an Agile Team
 
Agile 101
Agile 101Agile 101
Agile 101
 
CA Agile Requirements Designer 101 - an introduction to the general premise o...
CA Agile Requirements Designer 101 - an introduction to the general premise o...CA Agile Requirements Designer 101 - an introduction to the general premise o...
CA Agile Requirements Designer 101 - an introduction to the general premise o...
 
Adopting Agile
Adopting  AgileAdopting  Agile
Adopting Agile
 
Agile explained
Agile explainedAgile explained
Agile explained
 
Agile vs Iterative vs Waterfall models
Agile vs Iterative vs Waterfall models Agile vs Iterative vs Waterfall models
Agile vs Iterative vs Waterfall models
 
Tech Talk: Agile 101: You've Got Scrum Teams. So What?
Tech Talk: Agile 101: You've Got Scrum Teams. So What?Tech Talk: Agile 101: You've Got Scrum Teams. So What?
Tech Talk: Agile 101: You've Got Scrum Teams. So What?
 
Business agility
Business agilityBusiness agility
Business agility
 
Agile Software Development Overview
Agile Software Development OverviewAgile Software Development Overview
Agile Software Development Overview
 

Similaire à Technical writing in an agile development environment

Effective User Story Writing
Effective User Story WritingEffective User Story Writing
Effective User Story WritingAhmed Misbah
 
Perfect Backlogs - 3 July 2023
Perfect Backlogs - 3 July 2023Perfect Backlogs - 3 July 2023
Perfect Backlogs - 3 July 2023peter.croy
 
Scrum for IT Project Outsourcing
Scrum for IT Project OutsourcingScrum for IT Project Outsourcing
Scrum for IT Project OutsourcingMasoud Bolhassani
 
Agile Framework based on PMBOK 6th Edition.pdf
Agile Framework based on PMBOK 6th Edition.pdfAgile Framework based on PMBOK 6th Edition.pdf
Agile Framework based on PMBOK 6th Edition.pdfAliAfrazAjmal
 
Agile software development development explained
Agile software development development explainedAgile software development development explained
Agile software development development explainedServan Huegen
 
Agile - Basics.pptxjvjplhxitstistidara तिहोचपवपज्वो
Agile - Basics.pptxjvjplhxitstistidara तिहोचपवपज्वोAgile - Basics.pptxjvjplhxitstistidara तिहोचपवपज्वो
Agile - Basics.pptxjvjplhxitstistidara तिहोचपवपज्वोMnyMehr
 
Make better share point stuff with an agile methodology
Make better share point stuff with an agile methodologyMake better share point stuff with an agile methodology
Make better share point stuff with an agile methodologyDoug Hemminger
 
Essentials of Scrum
Essentials of ScrumEssentials of Scrum
Essentials of Scrumeikitakeuchi
 
Agile, not just for software
Agile, not just for softwareAgile, not just for software
Agile, not just for softwareJohn Paz
 
Agile Development with Scrum.pptx
Agile Development with Scrum.pptxAgile Development with Scrum.pptx
Agile Development with Scrum.pptxzuma14
 
Scrum Master Workshop
Scrum Master WorkshopScrum Master Workshop
Scrum Master WorkshopGlen Alleman
 
Understanding-Agile &Scrum.pdf
Understanding-Agile &Scrum.pdfUnderstanding-Agile &Scrum.pdf
Understanding-Agile &Scrum.pdfSwapnikaReddy6
 

Similaire à Technical writing in an agile development environment (20)

Effective User Story Writing
Effective User Story WritingEffective User Story Writing
Effective User Story Writing
 
Agile And Scum In a Nutshell
Agile And Scum In a NutshellAgile And Scum In a Nutshell
Agile And Scum In a Nutshell
 
Perfect Backlogs - 3 July 2023
Perfect Backlogs - 3 July 2023Perfect Backlogs - 3 July 2023
Perfect Backlogs - 3 July 2023
 
Scrum for IT Project Outsourcing
Scrum for IT Project OutsourcingScrum for IT Project Outsourcing
Scrum for IT Project Outsourcing
 
Agile Practice Workshop at Eye Care Leaders
Agile Practice Workshop at Eye Care LeadersAgile Practice Workshop at Eye Care Leaders
Agile Practice Workshop at Eye Care Leaders
 
BAAgileQA
BAAgileQABAAgileQA
BAAgileQA
 
Introduction to Agile
Introduction to AgileIntroduction to Agile
Introduction to Agile
 
Agile Framework based on PMBOK 6th Edition.pdf
Agile Framework based on PMBOK 6th Edition.pdfAgile Framework based on PMBOK 6th Edition.pdf
Agile Framework based on PMBOK 6th Edition.pdf
 
Agile software development development explained
Agile software development development explainedAgile software development development explained
Agile software development development explained
 
Agile - Basics.pptxjvjplhxitstistidara तिहोचपवपज्वो
Agile - Basics.pptxjvjplhxitstistidara तिहोचपवपज्वोAgile - Basics.pptxjvjplhxitstistidara तिहोचपवपज्वो
Agile - Basics.pptxjvjplhxitstistidara तिहोचपवपज्वो
 
Make better share point stuff with an agile methodology
Make better share point stuff with an agile methodologyMake better share point stuff with an agile methodology
Make better share point stuff with an agile methodology
 
Essentials of Scrum
Essentials of ScrumEssentials of Scrum
Essentials of Scrum
 
Scrum in One Day
Scrum in One DayScrum in One Day
Scrum in One Day
 
Introduction to Agile and Scrum
Introduction to Agile and ScrumIntroduction to Agile and Scrum
Introduction to Agile and Scrum
 
Agile, not just for software
Agile, not just for softwareAgile, not just for software
Agile, not just for software
 
Product Management In Agile Practice
Product Management In Agile PracticeProduct Management In Agile Practice
Product Management In Agile Practice
 
Agile Development with Scrum.pptx
Agile Development with Scrum.pptxAgile Development with Scrum.pptx
Agile Development with Scrum.pptx
 
Intro to Agile
Intro to AgileIntro to Agile
Intro to Agile
 
Scrum Master Workshop
Scrum Master WorkshopScrum Master Workshop
Scrum Master Workshop
 
Understanding-Agile &Scrum.pdf
Understanding-Agile &Scrum.pdfUnderstanding-Agile &Scrum.pdf
Understanding-Agile &Scrum.pdf
 

Dernier

Emergent Methods: Multi-lingual narrative tracking in the news - real-time ex...
Emergent Methods: Multi-lingual narrative tracking in the news - real-time ex...Emergent Methods: Multi-lingual narrative tracking in the news - real-time ex...
Emergent Methods: Multi-lingual narrative tracking in the news - real-time ex...Zilliz
 
AXA XL - Insurer Innovation Award Americas 2024
AXA XL - Insurer Innovation Award Americas 2024AXA XL - Insurer Innovation Award Americas 2024
AXA XL - Insurer Innovation Award Americas 2024The Digital Insurer
 
2024: Domino Containers - The Next Step. News from the Domino Container commu...
2024: Domino Containers - The Next Step. News from the Domino Container commu...2024: Domino Containers - The Next Step. News from the Domino Container commu...
2024: Domino Containers - The Next Step. News from the Domino Container commu...Martijn de Jong
 
EMPOWERMENT TECHNOLOGY GRADE 11 QUARTER 2 REVIEWER
EMPOWERMENT TECHNOLOGY GRADE 11 QUARTER 2 REVIEWEREMPOWERMENT TECHNOLOGY GRADE 11 QUARTER 2 REVIEWER
EMPOWERMENT TECHNOLOGY GRADE 11 QUARTER 2 REVIEWERMadyBayot
 
Navi Mumbai Call Girls 🥰 8617370543 Service Offer VIP Hot Model
Navi Mumbai Call Girls 🥰 8617370543 Service Offer VIP Hot ModelNavi Mumbai Call Girls 🥰 8617370543 Service Offer VIP Hot Model
Navi Mumbai Call Girls 🥰 8617370543 Service Offer VIP Hot ModelDeepika Singh
 
A Beginners Guide to Building a RAG App Using Open Source Milvus
A Beginners Guide to Building a RAG App Using Open Source MilvusA Beginners Guide to Building a RAG App Using Open Source Milvus
A Beginners Guide to Building a RAG App Using Open Source MilvusZilliz
 
GenAI Risks & Security Meetup 01052024.pdf
GenAI Risks & Security Meetup 01052024.pdfGenAI Risks & Security Meetup 01052024.pdf
GenAI Risks & Security Meetup 01052024.pdflior mazor
 
Cloud Frontiers: A Deep Dive into Serverless Spatial Data and FME
Cloud Frontiers:  A Deep Dive into Serverless Spatial Data and FMECloud Frontiers:  A Deep Dive into Serverless Spatial Data and FME
Cloud Frontiers: A Deep Dive into Serverless Spatial Data and FMESafe Software
 
Ransomware_Q4_2023. The report. [EN].pdf
Ransomware_Q4_2023. The report. [EN].pdfRansomware_Q4_2023. The report. [EN].pdf
Ransomware_Q4_2023. The report. [EN].pdfOverkill Security
 
Strategize a Smooth Tenant-to-tenant Migration and Copilot Takeoff
Strategize a Smooth Tenant-to-tenant Migration and Copilot TakeoffStrategize a Smooth Tenant-to-tenant Migration and Copilot Takeoff
Strategize a Smooth Tenant-to-tenant Migration and Copilot Takeoffsammart93
 
"I see eyes in my soup": How Delivery Hero implemented the safety system for ...
"I see eyes in my soup": How Delivery Hero implemented the safety system for ..."I see eyes in my soup": How Delivery Hero implemented the safety system for ...
"I see eyes in my soup": How Delivery Hero implemented the safety system for ...Zilliz
 
AWS Community Day CPH - Three problems of Terraform
AWS Community Day CPH - Three problems of TerraformAWS Community Day CPH - Three problems of Terraform
AWS Community Day CPH - Three problems of TerraformAndrey Devyatkin
 
Manulife - Insurer Transformation Award 2024
Manulife - Insurer Transformation Award 2024Manulife - Insurer Transformation Award 2024
Manulife - Insurer Transformation Award 2024The Digital Insurer
 
MINDCTI Revenue Release Quarter One 2024
MINDCTI Revenue Release Quarter One 2024MINDCTI Revenue Release Quarter One 2024
MINDCTI Revenue Release Quarter One 2024MIND CTI
 
Strategies for Landing an Oracle DBA Job as a Fresher
Strategies for Landing an Oracle DBA Job as a FresherStrategies for Landing an Oracle DBA Job as a Fresher
Strategies for Landing an Oracle DBA Job as a FresherRemote DBA Services
 
Architecting Cloud Native Applications
Architecting Cloud Native ApplicationsArchitecting Cloud Native Applications
Architecting Cloud Native ApplicationsWSO2
 
Apidays New York 2024 - Scaling API-first by Ian Reasor and Radu Cotescu, Adobe
Apidays New York 2024 - Scaling API-first by Ian Reasor and Radu Cotescu, AdobeApidays New York 2024 - Scaling API-first by Ian Reasor and Radu Cotescu, Adobe
Apidays New York 2024 - Scaling API-first by Ian Reasor and Radu Cotescu, Adobeapidays
 
Apidays New York 2024 - The value of a flexible API Management solution for O...
Apidays New York 2024 - The value of a flexible API Management solution for O...Apidays New York 2024 - The value of a flexible API Management solution for O...
Apidays New York 2024 - The value of a flexible API Management solution for O...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
 
MS Copilot expands with MS Graph connectors
MS Copilot expands with MS Graph connectorsMS Copilot expands with MS Graph connectors
MS Copilot expands with MS Graph connectorsNanddeep Nachan
 

Dernier (20)

Emergent Methods: Multi-lingual narrative tracking in the news - real-time ex...
Emergent Methods: Multi-lingual narrative tracking in the news - real-time ex...Emergent Methods: Multi-lingual narrative tracking in the news - real-time ex...
Emergent Methods: Multi-lingual narrative tracking in the news - real-time ex...
 
AXA XL - Insurer Innovation Award Americas 2024
AXA XL - Insurer Innovation Award Americas 2024AXA XL - Insurer Innovation Award Americas 2024
AXA XL - Insurer Innovation Award Americas 2024
 
2024: Domino Containers - The Next Step. News from the Domino Container commu...
2024: Domino Containers - The Next Step. News from the Domino Container commu...2024: Domino Containers - The Next Step. News from the Domino Container commu...
2024: Domino Containers - The Next Step. News from the Domino Container commu...
 
EMPOWERMENT TECHNOLOGY GRADE 11 QUARTER 2 REVIEWER
EMPOWERMENT TECHNOLOGY GRADE 11 QUARTER 2 REVIEWEREMPOWERMENT TECHNOLOGY GRADE 11 QUARTER 2 REVIEWER
EMPOWERMENT TECHNOLOGY GRADE 11 QUARTER 2 REVIEWER
 
Navi Mumbai Call Girls 🥰 8617370543 Service Offer VIP Hot Model
Navi Mumbai Call Girls 🥰 8617370543 Service Offer VIP Hot ModelNavi Mumbai Call Girls 🥰 8617370543 Service Offer VIP Hot Model
Navi Mumbai Call Girls 🥰 8617370543 Service Offer VIP Hot Model
 
A Beginners Guide to Building a RAG App Using Open Source Milvus
A Beginners Guide to Building a RAG App Using Open Source MilvusA Beginners Guide to Building a RAG App Using Open Source Milvus
A Beginners Guide to Building a RAG App Using Open Source Milvus
 
GenAI Risks & Security Meetup 01052024.pdf
GenAI Risks & Security Meetup 01052024.pdfGenAI Risks & Security Meetup 01052024.pdf
GenAI Risks & Security Meetup 01052024.pdf
 
Cloud Frontiers: A Deep Dive into Serverless Spatial Data and FME
Cloud Frontiers:  A Deep Dive into Serverless Spatial Data and FMECloud Frontiers:  A Deep Dive into Serverless Spatial Data and FME
Cloud Frontiers: A Deep Dive into Serverless Spatial Data and FME
 
Ransomware_Q4_2023. The report. [EN].pdf
Ransomware_Q4_2023. The report. [EN].pdfRansomware_Q4_2023. The report. [EN].pdf
Ransomware_Q4_2023. The report. [EN].pdf
 
Strategize a Smooth Tenant-to-tenant Migration and Copilot Takeoff
Strategize a Smooth Tenant-to-tenant Migration and Copilot TakeoffStrategize a Smooth Tenant-to-tenant Migration and Copilot Takeoff
Strategize a Smooth Tenant-to-tenant Migration and Copilot Takeoff
 
"I see eyes in my soup": How Delivery Hero implemented the safety system for ...
"I see eyes in my soup": How Delivery Hero implemented the safety system for ..."I see eyes in my soup": How Delivery Hero implemented the safety system for ...
"I see eyes in my soup": How Delivery Hero implemented the safety system for ...
 
AWS Community Day CPH - Three problems of Terraform
AWS Community Day CPH - Three problems of TerraformAWS Community Day CPH - Three problems of Terraform
AWS Community Day CPH - Three problems of Terraform
 
Manulife - Insurer Transformation Award 2024
Manulife - Insurer Transformation Award 2024Manulife - Insurer Transformation Award 2024
Manulife - Insurer Transformation Award 2024
 
MINDCTI Revenue Release Quarter One 2024
MINDCTI Revenue Release Quarter One 2024MINDCTI Revenue Release Quarter One 2024
MINDCTI Revenue Release Quarter One 2024
 
Strategies for Landing an Oracle DBA Job as a Fresher
Strategies for Landing an Oracle DBA Job as a FresherStrategies for Landing an Oracle DBA Job as a Fresher
Strategies for Landing an Oracle DBA Job as a Fresher
 
Architecting Cloud Native Applications
Architecting Cloud Native ApplicationsArchitecting Cloud Native Applications
Architecting Cloud Native Applications
 
Apidays New York 2024 - Scaling API-first by Ian Reasor and Radu Cotescu, Adobe
Apidays New York 2024 - Scaling API-first by Ian Reasor and Radu Cotescu, AdobeApidays New York 2024 - Scaling API-first by Ian Reasor and Radu Cotescu, Adobe
Apidays New York 2024 - Scaling API-first by Ian Reasor and Radu Cotescu, Adobe
 
Apidays New York 2024 - The value of a flexible API Management solution for O...
Apidays New York 2024 - The value of a flexible API Management solution for O...Apidays New York 2024 - The value of a flexible API Management solution for O...
Apidays New York 2024 - The value of a flexible API Management solution for O...
 
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
 
MS Copilot expands with MS Graph connectors
MS Copilot expands with MS Graph connectorsMS Copilot expands with MS Graph connectors
MS Copilot expands with MS Graph connectors
 

Technical writing in an agile development environment

  • 1. Technical Writing in an Agile Development Environment A Writer’s Perspective
  • 2. 2 Objectives  Learn to apply useful principles from agile methodologies  Highlight the features common to agile development processes  Understand user stories and learn to translate user stories into task-oriented topics  Learn to use various collaboration tools that can facilitate writing  Learn to be adaptive
  • 3. 3 The Agile Parable A pig and a chicken are walking down a road. The chicken looks at the pig and says, "Hey, why don't we open a restaurant?" The pig looks back at the chicken and says, "Good idea, what do you want to call it?" The chicken thinks about it and says, "Why don't we call it 'Ham and Eggs'?" "I don't think so," says the pig, "I'd be committed but you'd only be involved.”
  • 5. 5 Scrum Origins  The new product development game - Tekeuchi and Nonaka  A group of 17 individuals got together in Colorado in 2001 to form the Agile manifesto.  Jeff Sutherland and Ken Schwaber  Initial definitions of Scrum at OOPSLA 96  Not just for trivial projects  FDA-approved, life-critical software for x-rays and MRIs
  • 7. 7 Phases of Scrum– From Concept to Execution
  • 8. 8 The Scrum Development Process Daily Scrum •Hosted by ScrumMaster •Attended by all, but Stakeholders don’t speak •Same time every day •Answer: 1) What did you do yesterday? 2) What will you do today? 3) What’s in your way? •Team updates Sprint Backlog; Scrum Master updates Blocks List POPO Product Owner: Sets priorities SMSM ScrumMaster: Manages process, removes blocks TT Team (Pigs): Develops product SHSH Stakeholders (Chickens): observe & advise Key Artifacts Product Backlog •List of requirements & issues •Owned by Product Owner •Anybody can add to it •Only Product Owner prioritizes Product Backlog •List of requirements & issues •Owned by Product Owner •Anybody can add to it •Only Product Owner prioritizes Sprint Goal •One-sentence summary •Declared by Product Owner •Accepted by team Sprint Goal •One-sentence summary •Declared by Product Owner •Accepted by team Sprint Backlog •List of tasks •Owned by team •Only team modifies it Sprint Backlog •List of tasks •Owned by team •Only team modifies it Blocks List •List of blocks & unmade decisions •Owned by ScrumMaster •Updated daily Blocks List •List of blocks & unmade decisions •Owned by ScrumMaster •Updated daily Increment •Version of the product •Shippable functionality (tested, documented, etc.) Increment •Version of the product •Shippable functionality (tested, documented, etc.) Key Meetings Sprint Planning Meeting •Hosted by ScrumMaster; ½-1 day •In: Product Backlog, existing product, business & technology conditions 1. Select highest priority items in Product Backlog; declare Sprint Goal 2. Team turns selected items into Sprint Backlog Out:: Sprint Goal, Sprint Backlog Sprint Review Meeting •Hosted by ScrumMaster •Attended by all •Informal, 4-hour, informational •Team demos Increment •All discuss •Hold retrospective •Announce next Sprint Planning Meeting Product Backlog Product Backlog Development Process IncrementIncrement Sprint Planning Meeting Daily Scrum Daily Work Sprint Goal Sprint Goal Sprint Backlog Sprint Backlog Blocks List Blocks List ProductProduct Sprint Review Meeting Sprint: 15-30 days each Product Backlog’ Product Backlog’ Increment’Increment’ Copyright 2004, William C. Wake, William.Wake@acm.org, www.xp123.com
  • 12. 12 Making the Transition  How can I adapt myself to Scrum?
  • 13. 13 Design Documents  Moving from specs to user story documents  Shorter, more fluid documents  Allows for easier refinement and rework upon customer feedback  Helps the writers to not get bogged down in lengthy specs
  • 14. 14 User Stories- What is it?  A software system requirement  Defines what is to be built  Prioritized, make up the backlog  Stories may be related together as “features” or “themes”
  • 15. 15 User Stories As a … < role> … I want … <short description of feature> … So that … <value or why need functionality> … Examples:  As a sales manager I want to view the sales report so that I can know the sales for this quarter.  As a regular traveler I want my cell-phone to wake me up at a set time so that I do not need to pack an alarm clock.
  • 16. 16 Acceptance Criteria A common acceptance criteria template: Given … <some initial context > … When … <an event occurs> … Then … <ensure some outcomes> … Given my cell-phone is switched off when the time for my alarm is reached then turn the cell-phone on and sound the alarm.
  • 18. 18 Topic-Oriented Writing  Authoring concise, self-contained units of information about a specific topic  Concept  Task  Reference
  • 19. 19 Using Minimalism  Choose an action-oriented approach to your documentation  Promote learning by doing rather than by reading  Evaluate what to trim and why (‘Just enough’ documentation)  Focus on troubleshooting advice  Identify opportunities to replace text with graphics
  • 20. 20 Benefits of Using Minimalism  Pushes us to be more user-focused  Makes us look out for redundant information  Drives us to cut costs while delivering better information  Portrays us like we understood our role better
  • 21. 21 Collaborate  Use a collaboration tool (e.g. wiki)  Attend daily scrum meetings  Be detailed and specific when you are seeking information
  • 23. 23 Best Practices for Wiki Implementation
  • 24. 24 Using Wikis as an Input for Docs
  • 25. 25 Backlog is Your Friend  The Backlog in Scrum is the Technical Writer’s best friend.  Work with the dev team to understand the tasks  You can re-plan a Sprint in the mid-Sprint  Allocate some time in the Sprint for maintenance and patches.  Backlog is NOT DONE if the end-user documentation is not complete
  • 26. 26 Document Reviews in Scrum  Use drafts  Write doc for a feature that is developed and tested in the Sprint  Have Dev/QA review the doc for technical accuracy before closing the user story  Make the required edits  Publish IT  Present the doc to the PO in the exit meeting
  • 27. 27 Before the Release  Have a stabilization sprint for the document cleanups, versioning, and help integration.
  • 28. 28 Vertical Doc Team Structure – Writer Aligned to the Scrum Teams Write r Product ABC Product XYZ Released products Legacy Product s Feature A Feature B Feature A Feature B Feature A Feature B Bugs/ Minor Fixes Patche s Life Support Steve Maria Marc
  • 30. 30 The Benefits of Writing in an Agile Environment
  • 32. 32 Sources and Bibliography  Agile Estimating and Planning, Mike Cohn, Prentice Hall, 2006.  Agile Project Management with Scrum, Ken Schwaber, Microsoft Press, 2004.  Writing Effective Use Cases, Alistair Cockburn, Addison Wesley, 2001.  Agile Development: Challenges in Transforming Technical Communications Departments, Mike Wethington.  “An Overview of Scrum”, Mike Cohn, http://www.mountaingoatsoftware.com/presentation/30-an-overview-of-scrum , 2008  “Writing End-User Documentation in an Agile Development Environment,” Anne Gentle & Tana Berry, http://justwriteclick.com/2007/07/02/writing-end-user-documentation-in-an-agile-de , 2007.

Notes de l'éditeur

  1. A group of 17 individuals got together in Colorado in 2001to form the manifesto. This outlines that while there is value on the right, we value the items on the left more.