Is App documentation stretching you too thin?

The ability to effectively maintain and monitor apps projects is heavily dependant on the documentation being readily available.

The presence of reliable documentation ensures that knowledge transfer to new or existing project team members is consistent and provided without relying on others to spend time away from project activities. 

Maintaining your app documentation also contributes to the quality of the end product, as there is a consistent interpretation of the project across the entire team.

App documentation can present itself in many forms across a range of mediums. Documents such as User Manuals, Quick Start Guides, Requirements Analysis, Architectural Design and even Marketing Documentation falls under the banner of App documentation. These documents can be provisioned as hard copy or electronic documents.

One of the biggest issues with App documentation is its time consuming nature, which in a small team can create a constant tossup between development, testing and deployment requirements and ideal documentation. For those multifaceted professionals who fulfil the roles of a developer, tester and administrator, the time demand for high quality documentation can be daunting, considering other demands of the job.

This will inevitably lead to deteriorating quality of documentation, as the actual development will be prioritised. The expectation of the business will likely emphasise the rapid deployment of new applications to help streamline business processes and facilitate business functions.

Taking the K2 business process automation platform as an example, applications will typically have effective initial documentation resulting from requirements analysis. With an investment in such a platform, it is expected that this system efficiently bear fruit for the business, leading to a focus on development and testing.

Many versions of the application will likely be created with small changes constantly occurring to reflect on-the-fly user acceptance testing. These versions are unlikely to be comprehensively documented, as the intended final end product will be accompanied by the design documentation with the specification that it will meet.

Having effective documentation for all iterations of a K2 application will allow developers, testers and administrators to accurately and mutually understand the application’s evolution. The development activity will be more transparent, as changes to the application’s design and engineering can be discovered by comparing documentation across a spectrum of software versions.

Our K2 regression testing automation and administration software PowerToolz, provides functionality to automatically generate version documentation. Using the documentation features of PowerToolz an individual or multiple versions can be analysed and presented as a meaningful report which can be exported as a PDF. These documents include key information such as process activities, line rules, destinations, events and much more.

Simply execute the document generator using PowerToolz for every version of a K2 workflow, and the application will be comprehensively documented without spending hours at the desk typing!

To find out more about documentation features of PowerToolz and discover what else this amazing tool can offer your K2 Blackpearl environments, check out http://www.powertoolz.com.au.

If you have any queries regarding the tool please contact the jEyLaBs PowerToolz team via powertoolz@jeylabs.com.au

Leave a Reply

Please log in using one of these methods to post your comment:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google+ photo

You are commenting using your Google+ account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

w

Connecting to %s