Being Agile With Documentation
Upcoming SlideShare
Loading in...5
×
 

Being Agile With Documentation

on

  • 8,337 views

Agile environments can be both challenging and rewarding places for technical writers. Appropriate documentation is essential to the efficient production, testing, and acceptance of software. One ...

Agile environments can be both challenging and rewarding places for technical writers. Appropriate documentation is essential to the efficient production, testing, and acceptance of software. One way to be Agile with documentation to evolve it in parallel with the system development — delivering user stories, use cases, UI designs, system tests, manuals, and even online help — with just enough detail, and just in time. Come and explore some ways that you can be Agile with your documentation. This presentation isn't intended to provide a silver bullet solution, but it may give you some ideas beyond those famous (infamous?) 3x5 index cards.

Statistics

Views

Total Views
8,337
Views on SlideShare
8,274
Embed Views
63

Actions

Likes
8
Downloads
152
Comments
1

9 Embeds 63

http://www.slideshare.net 31
http://www.stcwestcoast.ca 13
http://sometechnology.blogspot.com 5
http://ardroncreative.com 4
http://www.ardroncreative.com 3
http://translate.googleusercontent.com 2
http://sometechnology.blogspot.in 2
http://www.linkedin.com 2
http://static.slidesharecdn.com 1
More...

Accessibility

Categories

Upload Details

Uploaded via as Microsoft PowerPoint

Usage Rights

© All Rights Reserved

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel

11 of 1

  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment
  • Feel free to ask questions as we are going along

Being Agile With Documentation Being Agile With Documentation Presentation Transcript

  • Being Agile with Documentation or… how technical communicators can survive (and thrive) on Agile Projects
  • Who am I, and why am I here?
  • What do you know about Agile…
  • So… What is Agile?
  • Individuals and Interactions
    • over processes and tools
  • Working Software
    • over comprehensive documentation
  • Customer Collaboration
    • over contract negotiation
  • Responding to Change
    • over following a plan
  • Sustainable Pace
    • Continuous attention to technical excellence and good design
  • Simplicity
    • Self-Organizing Teams Reflection and Improvement
  • But… what does it all mean? Don’t just do Agile… Be Agile
  • Now… what does that mean for technical writers?
    • writing and editing
    • document design
    • using language effectively to please or persuade (rhetoric)
    • problem solving
    • collaboration and teamwork
    • interpersonal and oral communication
    • facility with, and ability to learn, technologies
    Adapt your Core Competencies
  • The biggest difference is the Mindset
  • Integration with the Development Team
  • No Prescription for Documentation – so we will have to write our own
  • Whiteboards…
    • and Markers… and Cameras… oh my!
  • “Typical” Agile Requirements Documentation Create a new article for publishing Publish an article to the website Delete a published article
  •  
  • KIS and KIL
    • and a dollop of Horse Sense
  • Documentation and Coding should proceed in Parallel
  • Focus on Users and their Needs
  • Develop Design Patterns for your Documentation
  • Sources of Design Patterns
  • Design for Change
  • Some resources to check out
    • Manifesto for Agile Software Development www.agilemanifesto.org
    • Scott Ambler – Agile Modeling website http:// www.agilemodeling.com
    • WritersUS – Agile Technical Documentation www.writersua.com
  • Questions? Discussion?
  • Thank You [email_address]