10 Tips to Help You Achieve Your Software Testing Documentation Goal

Note: If you missed the first part of this post please read it: Why Documentation is important in testing?

As I mention in my earlier post, in general, understanding about software testing documentation is “It can be done only by the person who has free time”.  We need to change this mindset, and then only we can leverage documentation power on our projects.

It’s not that we don’t know how to do the documentation right. We just don’t think it’s important.

Everyone must have standard templates for all the kinds of documentation starting from Test strategy, test Plan, Test cases, and Test data to Bug report. These are just to follow some standards (CMMI, ISO etc.) but, when it comes to actual implementation how many of these documents are really used by us? We just need to synchronize our quality process with documentation standards and other process in an organization.

The simplest thing to follow all kind of documentation is to involve a person in project from kick off phase who understands the project dynamics, domain, objective, and technology. And who else better than a QA person for this (of course there are technical writers present to do this – but considering a general scenario of small companies where technical writers are not present).

To achieve this goal of testing and documentation I feel we need to focus on some points.

Here are the top 10 tips to help you achieve your software testing documentation goal:

1. QA should involve at the very first phase of project so that QA and Documentation work hand in hand.

2. Process defined by QA should follow by technical people, this helps remove most of the defects at very initial stage.

------------

3. Only creating and maintaining software testing templates is not enough, force people to use them.

4. Don’t only create and leave document, Update as and when required.

5. Change requirement is important phase of project don’t forget to add them in the list.

6. Use version controlling for everything. This will help you manage and track your documents easily.

7. Make defect remediation process easier by documenting all defects. Make sure to include clear description of defect, reproduce steps, affected area and details about author while documenting any defect.

8. Try to document what is required for you to understand your work and what you will need to produce to your stakeholders whenever required.

9. Use standard template for documentation. Like any excel sheet template or doc file template and stick to it for all your document needs.

10. Share all project related documents at single location, accessible to every team member for reference as well to update whenever required.

I am not saying that by applying above steps you will get sudden results. I know this change won’t happen in a day or two, but at least we can start so that these changes start happening slowly.

After all “the documentation needs documentation”.  Isn’t it?

Share your tips. How you maintain software testing documents related to your project?

This is a guest article by ‘Tejaswini patil’. She is working with an E-learning organization as an Associate Manager QA.



Recommended reading

36 comments ↓

#1 shruti

Very informative post. I agree, for every task involving QAs can make a big difference.

On our projects we generally update the the documents and put the name of updater/reviewer at the top of document with update version.

#2 Aman

Good information.

#3 Yathindra

Very useful Information, Keep it up!!

#4 Suzi

it becomes very hard when it comes to agile environment.

In agile env. you need to find out a strategy suitable for your work. We generally maintain abstract level documents without bothering more about all those reports :(

#5 Tejaswini

@ Suzi
Agree to your point. And it’s true in agile it’s difficult to maintain documents,but still i will suggest there should be something which QA should prepare, which avoid last min problem

#6 R N DADHU

Documuntation is ev, ent proof in record form

#7 Shital

Very good Info
we can create other docs as well like
Test matrix, Bug report or simple go throuth the application doc which will be very helpful for the new candidates who will going to use/test the application.

#8 sindhuG

we generally keep all documents at central location available for all team members review.

reviewer need to write his/her name and review comments in it. This is easy to be upto date.

#9 tjlee

Nice.
Our approach is to use enterprise wiki for all documents (its via https so can be accessible from everywhere) and JIRA for bug tracking…
So WiKi + JIRA = very nice for even huge project

#10 Malini

Cool basic tips teja.

There are many tools to do this in current trend without putting any extra effort. JIRA, Collaborate, Confluences, Sharepoint, Wiki and many more are there.

#11 Prabhakar V S

HI Sindhu

Valuable point.

#12 Amit Aswal

very good Articel

#13 Vinod Kumar Pandey

So Good Information…Thanks

#14 E-BOOKS

Nice information,I agree that documentation is a main part of testing.through documentation we provide a relevant way to test.

#15 Khushboo Shaikh

Great article.

True documention is important. Mostly neglected as it is time consuming. Person needs to be forced to maintain the document, then it gradually gets part of process.

#16 Kriti

Very very nice post……… It is really important to have all documents need for QA in Place and In correct version….. really very informative Post

#17 Tejaswini

@ Kriti

Thank you :)

#18 thejas H K

Dear vijay,

this is thejas, how can we improve our test cases writing skill and test scenarios skill..

regards
thejas..

#19 thejas H K

Hi vijay..

can u pls explain about tracebility matrix and how can we prepare it

regards
thejas..

#20 mahi

hi, this is mahi…. iam recently joined in a company as software tester and im fresher. in my company iam only the tester and there is no standard process for testing and am working on a maintainance product that is an intranet application it doesnt have proper documentation. so as a fresher how can i initiate the testing process and what methods used to test the maintainance product please inform me.

#21 sarav

hi,
i accquire many things about the software testing from this site. i luv to spend the time with this site. I am a tester in one of the software company. Really, this site helps me lot.
thk u…

#22 nidhi

this site given a lot of information about testing.thanku

#23 Time Management

Thanks for giving us such a nice information about Time Management Training

#24 A.Sen

Nice article.

#25 rajesh patil

a very good info for new comers . i think new one should follow this for better understanding.

#26 Raju

type master

#27 Security testing

Please can anybuddy, give me the idea, htat who to inject sql injection in web site url .

#28 Vaishali

I think your posts are great and gives us a better understanding of the software testing process. I am a fresh tester and feel that your post gives me right direction. Thanks!!

#29 vimal

Nice

#30 Augustine

hi Vijay, i joined an E-Commerce company and about a year ago i move to QA department as QA/software tester. There is no proper documentation (test plan/scenario) of testing in the QA department, i want to initiate this. I want create a test plan for a new redesigned software (.NET Wpf) how can i initiate this i.e. what is the best way to start writing test plan/cases for new sofware. i have been working with old software for over 12 months. please inform me.

#31 Sushma

Hi, i recently got a job in small organisation(E-learning) as QA. I am the only and first QA, obviously there’s no standard process set for testing, which i am trying to do so. But if you could please help me out on what kind of process i need to get started with and the documentation part as well, wud be great. :)
My email is: iam recently joined in a company as software tester and im fresher. in my company iam only the tester and there is no standard process for testing and am working on a maintainance product that is an intranet application it doesnt have proper documentation. so as a fresher how can i initiate the testing process and what methods used to test the maintainance product please inform me.

#32 Vikram Devaramane

Very useful information for test engineers please keep updating about the latest testing activities.
Thank You.

#33 Rahman sait

Hai i want to join software testing can you any one tel me the very very best training institute in bangalore.and provide me the contact details.i need real time practical session also..and how many students already placed that institute details also i need.

#34 Venkat Bhaskara

Excellent article. Your emphasis on documentation needs appreciation. However, the point is there is so little time allotted on projects to documentation that everyone tries to find a way to avoid it. Someone said it that only someone is free can work on the document. Can this perception be changed !!

#35 ashwini

i am working as a software tester as a fresher in small scale company .pls tell me how to improve quality of my product and maintain qualty of product mainly site related
projects are there on our company

#36 gowri

hi,i need help in defect management,how many defect wil raise in one small project.

Leave a Comment