Questions tagged [documentation]

Test documentation describes the artifacts created before, during, and after testing for the purpose of communicating with stakeholders to solicit feedback, to capture your intended approach to provide guidance for your team, to provide actionable information for business decision makers, and to record your findings for due diligence.

Filter by
Sorted by
Tagged with
15
votes
4answers
4k views

Documenting Unit Tests

We follow a BDD approach to development, we have our testers creating scenarios from a specification, and these are then given to our developers before any work is started. However, we find that some ...
14
votes
5answers
214 views

visualizing the chronology of a discovery process

Meta: this is probably not a question for which there is a single, objective, best answer, but I'm going to ask it here anyway because it's applicable to our jobs and non-obvious. I spent three ...
13
votes
9answers
5k views

Testing using real data of the customer

Is it common to use real data of the customer to perform testing? What policies companies apply regarding using real data of the customer for testing purposes? Is there any legislations regarding such ...
12
votes
5answers
1k views

Test Strategy Documentation

What are the main points that should be included in a test strategy document for a particular project? I'm not looking at details but more from a high level overview. I would like to make it a brief ...
11
votes
4answers
7k views

How do you write a great bug report? [closed]

"Is this going to be a stand-up fight sir, or a bug hunt?" - Hudson I've always wondered what the secrets were to writing a great bug report. Over time I've narrowed down the activity to three ...
10
votes
4answers
312 views

What do you do when you encounter overloaded terminology in your workspace?

I've been in many difference sized companies and in many different environments where we've used terms interchangably, Testing Terms, Development Terms and Process types have been overloaded in one ...
10
votes
6answers
2k views

How to organize test documentation?

Testing process involves plenty of documentation. How to organize it, so that it is easy to get an information that is needed?
9
votes
1answer
454 views

How do I deal with poorly documented tests?

I work in a big multinational company. There are too many testers in my company whose test cases (i.e. test steps) are unclear & are riddled with grammatical errors. Many of these testers are ...
9
votes
5answers
15k views

Release Notes Best Practices

What are some tips for writing good release notes? Any best practices or examples? My audience is both my QA department and the executive team.
8
votes
3answers
258 views

New Hire: lack of documentation vs QA velocity

I've been thinking to raise this question long time ago since I ever started my career as Software QA. We, as IT professionals (that's how I consider us, regardless of the education level) are always ...
8
votes
1answer
2k views

Any tricks to using Microsoft Word to build cross-referenceable requirements statements in test plan documentation?

I'm in the process of updating document templates for a customer. Part of the documentation template stack are the usual QA items: Requirements (RS), Architecture (ADD), Test Plan (TP) and Test Report ...
7
votes
3answers
901 views

How can I organize QA documentation within an Agile environment

In Agile we favour immediate communication over documentation. However, in QA we still have a need and desire to document the process to provide structure and guidance. What high-level structure in ...
7
votes
2answers
74 views

Best practice guide for documenting unit tests?

A set of a unit tests for a project 3+ years old, now fail. It seems the tests themselves have become out of date, and I've wasted time trying to find non existent bugs. To prevent this happening ...
7
votes
2answers
226 views

How to link test cases back to the requirement (specification) document, and vice-versa

We are slowly generating small automated test cases for some software we develop. We've only got a few dozen or so written so far and we expect that in the end, we will have a few hundred, maybe a few ...
6
votes
6answers
2k views

I am a Junior software QA specialist, I am kind lost to understand what to do in this scenario?

Scenario: Suppose that there is a mobile application (Hotel Booking). A particular use case does not work as expected (view booking history), as it has several defects and the business requirements ...
6
votes
4answers
738 views

How do you adapt agile testing techniques to a regulated industry?

The StackExchange search seems to think this is a subjective question. I'm not sure about that. It seems pretty straightforward. Agile methodologies of software development involve more than just ...
6
votes
4answers
321 views

What is normal communication when a developer moves a ticket to Ready for Test?

I have had a bit of ongoing debate and discussion with the developers on my team about the amount of information expected when a developer completes work on a ticket and passes it to QA. We are an ...
5
votes
6answers
208 views

How do I deal with poorly documented bugs?

I sometimes come across bugs that do not have enough information to reproduce the bug, or worse, understand what the issue is in the first place. Usually, business analysts, rookie QAs & ...
5
votes
9answers
2k views

Is there some software to document the results of functional software testing?

Can anyone recommend some software that can be used to document the results of functional software testing? This is not at developer level, it is for testers to follow documented procedures/scripts ...
5
votes
2answers
789 views

Which Reporting should a QA Engineer be providing?

I've worked in QA for a number of years now and not once have I (personally) created/generated any sort of report, maybe its just where I've worked has never required it. Browsing the market I notice ...
5
votes
2answers
217 views

What are acceptable time to spend and taks to be done analysing a defect as a tester?

Morning, what are an acceptable time and tasks to analyse a defect as a tester? Following situation: As our QA teams waits for a new client version and our preparations are quite done we had a look ...
4
votes
3answers
87 views

Test Case for Each Unit Test?

It seems highly impractical to have a test case/ticket for every unit test; however, the only experiences I have to draw from are from college, and an internship -both of which stressed having each ...
3
votes
4answers
198 views

The structure of test logs?

I am working on a project which involves documenting test logs. I want to know the structure of test logs (what should be included).
3
votes
4answers
10k views

What is Bi-directional Traceability Matrix?

How is it different from a Requirement Traceability Matrix (RTM)? Please explain with real life scenarios and examples. Also include or link reference material that might help!
3
votes
2answers
17k views

Writing Test cases in an agile approach

I use to develop test cases in the traditional way by defining the following for each test senario:- Test case name. “View Current Transaction” Pre-condition. Valid “Username & password” The ...
3
votes
2answers
71 views

Is it okay to test the absence of exceptions or error messages in an application?

There is a web page which is supposed to display current month's sales of five types of items. One bug report says that a server error message is displayed on this page and the sales report is not ...
3
votes
3answers
368 views

Bug reporting on documents

In my job I have to test Markdown documents. This includes looking for bugs related to: The procedure described in the document Typos, grammar mistakes, etc. The HTML version of the document Right ...
3
votes
3answers
161 views

Is a Final Release Report a good way to communicate results?

I'm getting ready to release the next version of our software. In the past when the release is ready to go I will send around an email saying "release xxx is done" and include a basic set of release ...
3
votes
3answers
176 views

Good resource for a test case document

I am wondering if there is a template for test case documentation online, preferably on excel. After searching for some useful information, I am not finding anything I like. I have written these by ...
3
votes
2answers
89 views

How do we effectively use mind maps (or anything similar) to demonstrate key areas (to test & impacted) while planning testing of complex new feature?

I was recently testing a new feature that impacts all most the entire application. While I was trying to communicate the business impact to my team I found it difficult to emphasize on it by the ...
3
votes
3answers
2k views

Which one i should make? complex test scenario and test case or checklist?

I know that test scenarios, test cases and checklists are different things and are important for testing. I've landed a job as a QA in startup that's adopted scrum methodology and is fast paced. ...
3
votes
2answers
105 views

Handling of Test Documents throughout Retests

Community, I'm currently doing development and tests for a Windows Desktop Application that plays together with some PLCs. One of my main tasks is to perform Functional Tests on a System Level for ...
2
votes
6answers
2k views

Validation and verification in CMMi, ISO, IEEE. What should I refer to?

Working on my master thesis, today I found this site (I previously asked on programmers) so I hope you will not mind if I ask here to get more great answers. The thing is that I have to classify ...
2
votes
4answers
160 views

Can a Software QA take over all the documentations needed for the project?

I have been included in a very big project, with surprisingly, unorganized - to none - documents. Every meeting, we had been asking for documents back and forth and they can't provide one. There's ...
2
votes
2answers
87 views

Mind maps vs spreadsheets

We've been using Google docs spreadsheets to keep test scenarios for manual testing of our applications for quite a long time. Recently, we've started to use mind maps as well, mapping the ...
2
votes
4answers
746 views

What software do you use to write release notes? [closed]

We want to move from MS Word to a web-based tool for our release notes. What software do you use? Ideally, we want to use the same tool to track bugs and generate the Release Notes. Thanks
2
votes
2answers
36 views

Who needs to receive test documentation?

Besides my manager who do I need to distribute test documentation to? E.g. master test plan and master test report. Do I need to send the product owner/business representative, who is unfamiliar ...
2
votes
2answers
85 views

How to document my page object

What are some efficient and non-tedious ways to document my page objects? What I first did was take screen shots of my screen and label each page object to its corresponding web element but this ...
2
votes
1answer
150 views

Lean documentation

Currently I am the only one responsible for the quality of the company's products, so when I get a requirements elicitation, I don't have time to do all the documentation, i.e. I get the LR and I've ...
2
votes
2answers
97 views

How do you document the PROCESS of fixing bugs independent of product/technology

It seems relatively easy to find bug tracking tools, but I'm looking for a way to document the process of fixing the defects that will track things such as: who is working on it, being sure that it ...
2
votes
1answer
4k views

Is Selenium 2 WebDriver JavaDoc API available offline?

Can I get a offline copy/archive of Selenium Webdriver Javadoc API which is available here so that I can bind the same to my Eclipse IDE for offline use? A ready-made HTML archive will be ...
2
votes
1answer
97 views

What kind of documentation do I need for testing new site against old?

I'm a Product Manager, not ideally tasked with but enjoying directly managing a new SQA team. AdHoc testing has covered a lot of quick ground, but I think it's now time to implement better ...
2
votes
1answer
54 views

How to specify target in the TakesScreenshot interface's getScreenshotAs method

On reading the Java documentation of TakesScreenshot interface, it was observed that the method syntax and description for getScreenshotAs are: getScreenshotAs(OutputType<X> target) ...
2
votes
1answer
77 views

Beginner S.R.S testing section writing advice

I'm writing the Testing section for a SRS for a group project. We started out with the IEEE std 830-1993 SRS template but have kinda moulded it around our project to suit our needs. We are taking an ...
2
votes
1answer
86 views

How to test and document a third-party application?

I'm working at a small organization which is hosting a third-party application (business software) for our users. The software is quite comprehensive; we are using only a subset of the functionality. ...
2
votes
2answers
462 views

Documenting application test coverage

We have both automated and manual tests for our actively developed application. A regular Jira workflow in our case is something like this: Open -> In Development -> In Testing -> In ...
2
votes
1answer
115 views

Creation of bug specification

I am currently testing a piece of vehicle management software. To kill two birds with one stone I am also going to create a user guide, alongside a similar document to point out and describe bugs. ...
2
votes
1answer
33 views

How have you automated the generation of software test documentation for ISO62304 testing?

I am working in a Medical Device/FDA/ISO62304 Software documentation world. I would like to know from those who document unit and integration tests, how do you document testing. Part of the reality ...
1
vote
2answers
2k views

What is UAT Protocol?

I've just wrote an UAT script specifying all of the use cases step by step (quite standard). However the customer is asking us for a UAT protocol and we have no clue on what he means by that. Anyone ...
1
vote
2answers
1k views

What is the difference between SRS, RA, FRS, BRS documents?

I know I should ask this question in "Theoretical Computer Science" stack community. But as the name suggests, that community would provide me answer which is everywhere on internet-Theoretical. But I ...