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
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 ...
1
vote
1answer
54 views

Automated test execution custom pdf reporting tool

I am automating a desktop based application testing. My requirement is that based on my execution for a particular test, i would like to mark real time results in pdf generated by the automation ...
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.
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 ...
-1
votes
1answer
32 views

For which purposes, projects and teams, test cases and checklists are better compared to each other? [closed]

I was wondering which advantages and disadvantages test cases and checklists have compared to each other. For which teams and projects each option is better?
1
vote
1answer
38 views

How to document the paths of my windows service in an easy to read diagram?

I have a windows service that issues thousands of android ADB commands to devices, I plan to go through the source for it and document all possible scenarios/paths, there are a lot of if x do y ...
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 ...
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 ...
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) ...
0
votes
1answer
136 views

Test Structure Analysis Documentation

Detail Information Currently I am in the process of building a QA structure, the following points are included and each one is designed for a project. Since I would like to start with the analysis ...
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. ...
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 ...
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 ...
1
vote
1answer
18 views

How to provide non-technical users with better rspec output

When writing UI automation specs RSpec has a great option --format=documentation You can combine this with --dry-run and get instant tests as documentation... The only problem is that it has all ...
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 ...
0
votes
4answers
124 views

What are the documents maintained in software quality assurance?

What are documents(software quality assurance related only), a software quality assurance engineer,QA lead has to maintain/create while testing a software from the beginning to the end? ...
1
vote
1answer
48 views

Testing tools: poor documentation vs investigating yourself

With a recent, wild development of different libraries (mostly JavaScript), very frequently in the internet atmosphere, we come across with some awesome open source testing tools, that promise to help ...
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 ...
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 ...
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
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 ...
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 ...
0
votes
3answers
491 views

Where can I find examples of software development and testing documentation? [closed]

I am looking for real-life working examples of documentation of a software development project (including testing). According to some standard, there are a couple of documents involved in software ...
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 ...
0
votes
2answers
247 views

Interview Question: How to plan and design testing for a web application?

For example, how would you test the login functionality of a system and what would be your approach (during the interview) to show a true understanding of the QA role ? I am not looking for test cases,...
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 ...
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 & ...
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 ...
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!
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 ...
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 ...
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 ...
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 ...
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 ...
1
vote
1answer
94 views

Reusing Data Definitions Across Multiple Forms

We're building requirements for some data input that has four different variations. There are some common fields across all four variations, and then some additional fields based on form type. For ...
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 ...
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 ...
1
vote
1answer
134 views

How to document testing in Agile environments? [closed]

The "Working software over comprehensive documentation" agile value is one of the most controversial. Regarding testing, how do agile test team achieve "Just Barely Good Enough Models and Documents"? ...
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 ...
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 ...
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 ...
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 ...
0
votes
1answer
389 views

Is it ok to use Gherkin syntax to describe scenarios for backend applications?

I use gherkin syntax to write the scenarios of features that involve user interaction. However, I'm not sure if it is the correct syntax to describe scenarios to test backend applications. If your ...
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?
0
votes
1answer
67 views

Can you get paid for reporting multiple bugs for a mobile app? [closed]

So I'm taking a QA course for my undergrad degree and we had to choose an app to test that we haven't used before. We already found several major bugs in the app and was wondering if the mobile app ...
1
vote
1answer
3k views

How to write technical documentation for Android Project? [closed]

I have created SRS document, and little Design document. Now, i am struggling to create Technical document which must be used as Reference for new developers when we assign update task to them. What ...
1
vote
1answer
122 views

What suggestions can people give about creating organized test cases?

Right now my company uses a large excel spreadsheet to create 'tests' for surveys we develop. Each column is one test through the survey. Each field is the answer you should choose. While this ...
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
1
vote
1answer
96 views

When creating a manual test script, can I reference other test scripts?

I need to write and execute some test scripts and provide evidence on a short time-frame. The basic scenario revolves around creating work requests in one system, and approving or rejecting them in ...