Agile Documentation

-


Image Source: Tech Writers Tribe Agile Manifesto 


With the adoption of Agile Manifesto, software development has changed its trajectory and so is the documentation. Agile software development paved the way for the technical documentation to change from normal documentation to Agile documentation process. One of the core principles in Agile Manifesto is Working software over comprehensive documentation” 

This principle introduces two things for technical writers: 

  • Stronger collaboration with the developers’ team to build documentation in line with the software development lifecycle.
  • Minimum viable documentation that is good enough so that your customers can use that documentation right away.

Software Developers and Technical Writers


In Agile documentation, both the writers and developers respond to change quickly instead of following a predefined plan. Agile documentation is nothing but producing documentation based on Agile Manifesto. Technical writers work closely with the software developers to prepare product documentation at a pace aligned with software developers as per their sprints. 

Importance of Agile Documentation 


Software and documentation to be released concurrently to enhance customer experience. Adopting the same agile methodology shall help the documentation team and developers to be consistent with development.

Strong collaboration between developers and documentation writing team. Agile documentation provides vast opportunities for to focus on customer requirements and become the part of software development cycle which in turn enhances the product experience. It adopts most of the agile practices in their day to day documentation activities. Hence, product and documentation are considered as one entities rather than separate ones. 

 Author: Swati Mishra

Comments

Post a Comment

Popular posts from this blog

Document Development Life Cycle (DDLC)

-
Image
Six phases of DDLC: DDLC is a systematic way of developing technical documentations in standard format. It consist of six areas: Phase 1: Requirement Gathering Phase 2: Planning the content Phase 3: Developing the content Phase 4: Reviewing the conent Phase 5: Publishing the content Phase 6: Maintaing the content This cycle is excellent if it works with everything else in your organization; e.g., development of product cycle. Implementation of DDLC and its adherence is not that easy. Most of the tech organizations in India maintain the content in traditional formats like PDF and Word. So, it is not easy to maintain and update those documents timely unless they have proper content review cycle.  How Relevant is DDLC for the team? The entire process of creating and maintaining the documents is critical for the knowledge management of the team. Having a documented track of all the product summary strengthens the foundation of the product range of the organization. 
Read more

Topic Based Authoring

-
Image
There are two kind of authoring, one is Topic Based Authoring and other one is Narrative Authoring. In Technical writing, for large documentation we use Topic Based Authoring. What is Topic Based Authoring? In Topic based authoring, we follow a modular content creation approach where we produce content in modules and compile them to form a large technical document. These modules are independent and can be created by different authors. In this way, several authors contribute towards the large documentation.  Tools used for Topic Based Authoring There are several tools available in market for Topic Based Authoring. Few examples are: DITA  Madcap Flare AEM Confluence Adobe Robohelp DITA is the most popular topic based authoring tool being adopted by several tech organisations. In next blog, we will cover about DITA in detail. 
Read more

Cloud Computing and its various aspects

-
Image
Cloud Computing Currently, over 90% of the organizations in the world are using cloud computing services to host their business infrastructure. The entire infrastructure set up is provided over the internet by a remote data center provided by a cloud service provider. The cloud infra requirements works on a consumption based pay-as-you-go model, organizations pay for the cloud services they use and not for comprehensive services all at once. The most common daily use examples of cloud computing is Google photos, Google drive, Gmail, Amazon Prime, Microsoft OneDrive, etc.  Image Source: Cloud Computing Let’s dive deep into various aspects of cloud computing. Advantages of Cloud Computing: Compared to the traditional IT infra set up, cloud computing offers various advantages. These are: Lower IT Cost : Organizations adopting cloud infrastructure are free of cost and effort of purchasing, installing, configuring, and managing the on-prem infrastructure. Improve agility and time to va...
Read more