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.

 
2 favorite thumb_down thumb_up 2 comments visibility_off  Remove from Watchlist visibility  Add to Watchlist
 

Outline/structure of the Session

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 1 year ago

Comments Subscribe to Comments

comment Comment on this Proposal
  • Naresh Jain
    By Naresh Jain  ~  1 year 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  ~  1 year 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


  • Anand Bagmar
    Anand Bagmar
    schedule 1 year ago
    Sold Out!
    45 mins
    Demonstration
    Intermediate

    Building a Test Automation Framework is easy - there are so many resources / guides / blogs / etc. available to help you get started and help solve the issues you get along the journey.

    However, building a "good" Test Automation Framework is not very easy. There are a lot of principles and practices you need to use, in the right context, with a good set of skills required to make the Test Automation Framework maintainable, scalable and reusable.

    Design Patterns play a big role in helping achieve this goal of building a good and robust framework. 

    In this talk, we will talk about, and see examples of various types of patterns you can use for:

    1. Build your Test Automation Framework
    2. Test Data Management
    3. Locators / IDs (for finding / interacting with elements in the browser / app)

    Using these patterns you will be able to build a good framework, that will help keep your tests running fast, and reliably in your CI / CD setup!

  • Anand Bagmar
    Anand Bagmar
    schedule 1 year ago
    Sold Out!
    90 mins
    Workshop
    Intermediate

    CI (Continuous Integration) and CD (Continuous Delivery) are now a necessity and not a luxury! Testing (automation) is one of the important practices that needs to be setup correctly for CD to be successful. But, this is tricky and requires a lot of discipline, rigor and hard work by all the team members involved the product delivery. The Test Automation Pyramid is a great concept that helps teams focus on the "right" type of automation.

    To add to the never-ending challenges, a new architecture style has evolved - Microservices Architecture. While there is no precise definition to explain Microservices style, it essentially talks about how to break a monolith application into smaller, independent pieces - usually based on business capability, automated deployment, and various other factors.

    In teams building a complex product using the Microservice Architecture approach, the Testing approach also needs to evolve to be effective and validate the functionality quickly, and effectively.

    But why does the Testing approach needs to be different for Microservice Architecture?
    Here is an example: If your product architecture is something similar as seen here, or here, to make testing effective, and enable fast feedback, you need to break down the testing approach from an end-product (monolith black-box) into smaller components - in this case - at individual service, combination of services, etc. level.

    In this workshop, learn, via a game-based activity, correlated with a case study of an Enterprise (, a large Bank), the Testing approach required to take them on the journey to achieving CD in the Microservice world. We will also learn how to break down the test automation pyramid at a Microservice level into smaller test automation pyramids - i.e. Micro-Pyramids to enable early feedback about quality of the product.

  • Anand Bagmar
    Anand Bagmar
    schedule 1 year ago
    Sold Out!
    45 mins
    Experience Report
    Intermediate

    Distributed organisation / projects / teams is not a new phenomenon. It is a reality. Another reality is large organisations, primarily due to the size, have different operational structure - which results in separate role-based teams and often CoEs (Centre of Excellence) too!

    Though this may work upto a certain level, the separate way of organising and structuring causes impediments, silos and blockers in the way a quality product is built and delivered.

    This brings an important question in my mind - do we really work well on such distributed teams?

    In this session, learn some practices and techniques to bridge the gap and make working in distributed teams “relatively easier”.

  • Anand Bagmar
    Anand Bagmar
    schedule 1 year ago
    Sold Out!
    45 mins
    Case Study
    Intermediate

    CI (Continuous Integration) and CD (Continuous Delivery) are now a necessity and not a luxury! Testing (automation) is one of the important practices that needs to be setup correctly for CD to be successful. But, this is tricky and requires a lot of discipline, rigor and hard work by all the team members involved the product delivery. The Test Automation Pyramid is a great concept that helps teams focus on the "right" type of automation.

    To add to the never-ending challenges, a new architecture style has evolved - Microservices Architecture. While there is no precise definition to explain Microservices style, it essentially talks about how to break a monolith application into smaller, independent pieces - usually based on business capability, automated deployment, and various other factors. 

    In teams building a complex product using the Microservice Architecture approach, the Testing approach also needs to evolve to be effective and validate the functionality quickly, and effectively. 

    In this talk, learn, via a case study of an Enterprise, a large Bank, the Testing approach required to take them on the journey to achieving CD in the Microservice world. We will also learn how to break down the test automation pyramid at a microservice level into smaller test automation pyramids - i.e. Micro-Pyramids to enable early feedback about quality of the product.

     

  • Anand Bagmar
    Anand Bagmar
    schedule 1 year ago
    Sold Out!
    45 mins
    Talk
    Intermediate

    Learn what is Web Analytics, why is it important, and see some techniques how you can test it manually and and also automate that validation. But just knowing about Web Analytics is not sufficient for business now.

    There are new kids in town - IoT and Big Data - two of the most used and heard-off buzz words in the Software Industry!

    With IoT, with a creative mindset looking for opportunities and ways to add value, the possibilities are infinite. With each such opportunity, there is a huge volume of data being generated - which if analyzed and used correctly, can feed into creating more opportunities and increased value propositions.

    There are 2 types of analysis that one needs to think about.
    1. How is the end-user interacting with the product? This will give some level of understanding into how to re-position and focus on the true value add features for the product.
    2. With the huge volume of data being generated by the end-user interactions, and the data being captured by all devices in the food-chain of the offering, it is important to identify patterns from what has happened, and find out new product / value opportunities based on usage patterns.


  • Anand Bagmar
    Anand Bagmar
    schedule 1 year ago
    Sold Out!
    45 mins
    Talk
    Beginner

    With all the focus on Test practices and tools getting better for the present, it is easy to forget about the Future of Testing, especially in terms of Tools and Infrastructure? A question that always comes up in my mind - “Are we so caught up in the past and present, that we will not be as effective in the future?”

    In this talk, we will go on a journey to figure out what new challenges are coming up in the future, and more importantly, what do we need to do next to prepare for it. Also, just preparing for the future is not sufficient. We have an opportunity to stretch beyond our current set of skills, capabilities and boundaries to influence out future! The question is - will we make use of this opportunity?