Challenges and Best Practices: Creating Customer Focused Documentation in an Agile Framework

Agile is an increasingly popular development method primarily used by software companies. In Agile software development, work is confined to a regular, repeatable work cycle, known as Sprint. A sprint typically lasts for two to three weeks. In Agile, development teams strive to deliver a fully functioning, high quality, and potentially shippable product increment at the end of each sprint. Hence, product documentation becomes an essential part of the sprint deliverable to meet stakeholder requirement. Since, the primary focus of Agile development is to deliver products with high quality, technical communicators are expected to create customer focused documentation with high quality.

Creating Customer focused documents involves paying great attention to needs and opinions of customers, and creating documents with a purpose. As writers we must ensure that the documents we create focus on the needs of the actual customers of the document and provides value. As writers we must identify who the potential customer(s) for our documentation are, what they require, and create minimal documentation that they actually need. By understanding the needs of our customers we will be able to deliver customer focused documentation with high quality. However, the combination of Agile’s high speed of development, short delivery cycles, and limited requirements documentation presents a unique set of challenges in creating customer-focused documentation.

This paper highlights some of the challenges writers face and provides best practices that can be used in creating customer-focused documentation in an Agile framework.

 
 

Outline/Structure of the Talk

I've timed the entire presentation for 35 minutes.

Here's the outline of my session:

  • Agile Introduction - 5 minutes
  • Challenges in creating customer-focused documentation in an Agile framework - 15 minutes
  • Best Practices to create customer-focused documentation in an Agile framework - 15 minutes

Learning Outcome

This paper highlights some of the challenges writers face and provides best practices that can be used in creating customer-focused documentation in an Agile framework.

Target Audience

Scrummasters,Product Owners, Documentation Managers, Technical Writers

schedule Submitted 3 years ago

Public Feedback

comment Suggest improvements to the Speaker
  • Naresh Jain
    By Naresh Jain  ~  3 years ago
    reply Reply

    Hi Tony,

    This is an important topic and I'm glad you've proposed a sessions. IMHO instead of a 45 mins talk, can you present this as a 20 mins experience report where you highlight top 3 challenges and how you've resolved them?

    Also we would need a video and slides (from a past presentation) to understand your presentation skills.

    Please update your proposal accordingly.

    • Tony Xavier
      By Tony Xavier  ~  3 years ago
      reply Reply

      Hi Naresh,

      Apologize for the late reply. I can definitely make it a 20 min experience report. :)

      Currently, I don’t have any videos that I can share with you. However, I can send you my presentation slides. Let me know, if that works for you.

      Request you to share your mail address.

      Regards,

      Tony