Agile & Documentation — a Framework for Success

 

Agile does propose to focus on development over documentation. But does that mean that tech companies should drop — or heavily reduce — all documentation in favor of development?

I interviewed Shanly Suepaul, Senior Web Technologist & Certified Scrum Master, and Nathalie Crosbie, Associate Director of Experience Design to find out.

You can read the entire interview here.

Or, if you haven’t already had the chance to read the article version of our discussion — you can find it here.

Frameworks for Success

Ask yourself the right questions and you’ll find you start to get the right answers. When it comes to documentation — balance is key. Here are a series of questions that will help you identify when, where and how much documentation you actually need.

The Documentation Checklist

Thinking about documentation:

Where do we think we need documentation?

Do we really need it?

What’s my client’s expectation on what’s being done here?

OK, we need documentation:

What’s my goal?

What do I want this to achieve? What is this specific documentation for?

Why do I want to achieve this? Is there another way?

Building documentation:

Who’s my audience?

How do I balance not doing X-number of versions of this?

Have I done enough?

Can I do more?

Can I do less — and still have the same impact?

Am I being ethical and responsible here?

Reviewing documentation:

How am I going to measure success about my documentation?

How are my audience’s using my documentation?

How can I improve this?

Addressing the above questions should help you clarify your documentation process. Please, add, remove or adjust the questions as needed. This is meant to spark thought and help guide you — but it’s by no means an exhaustive list.

Published by: Cahill Puil

Framework: Nathalie Crosbie, Shanly Suepaul

Written by

Cahill Puil

Cahill Puil

Sign up for our newsletter