# \#documentation **URL:** https://club.ministryoftesting.com/tag/documentation/102.md [Latest](https://club.ministryoftesting.com/latest.md) · [Categories](https://club.ministryoftesting.com/categories.md) · [Tags](https://club.ministryoftesting.com/tags.md) --- ## [Overly detailed test cases for new starters v assumed knowledge in test cases](https://club.ministryoftesting.com/t/overly-detailed-test-cases-for-new-starters-v-assumed-knowledge-in-test-cases/84604)
**Author:** [@gulshanb](https://club.ministryoftesting.com/u/gulshanb)\ **Replies:** 12\ **Last updated:** [19 October 2026 09:45 UTC](https://club.ministryoftesting.com/t/overly-detailed-test-cases-for-new-starters-v-assumed-knowledge-in-test-cases/84604 "2026-10-19T09:45:11Z")
A general discussion about the pros and cons of both approaches. Writing detailed test cases can help with onboarding new starters, and can even act as a training medium. Conversely, having to trawl through test steps t… --- ## [Do Support Docs Belong in the QA Toolkit?](https://club.ministryoftesting.com/t/do-support-docs-belong-in-the-qa-toolkit/87167)
**Author:** [@jesseberkeley](https://club.ministryoftesting.com/u/jesseberkeley)\ **Replies:** 12\ **Last updated:** [10 March 2026 08:48 UTC](https://club.ministryoftesting.com/t/do-support-docs-belong-in-the-qa-toolkit/87167 "2026-03-10T08:48:55Z")
Hey you wonderful MoTers :waving\_hand: As QAs / SDETs in agile teams, do you create or influence support documentation (internal or customer‑facing) as part of your quality‑infusing role? I’m curious how others approac… --- ## [Is creating Test Plan disappearing in Agile world?](https://club.ministryoftesting.com/t/is-creating-test-plan-disappearing-in-agile-world/86554)
**Author:** [@preetig](https://club.ministryoftesting.com/u/preetig)\ **Replies:** 10\ **Last updated:** [27 August 2025 08:24 UTC](https://club.ministryoftesting.com/t/is-creating-test-plan-disappearing-in-agile-world/86554 "2025-08-27T08:24:48Z")
With the Agile process so popular and being followed in most of the organisations, I feel Test Plan creation is being lost. Every project is divided in small user stories and these stories being distributed in each sprin… --- ## [Test cases VS No Test cases](https://club.ministryoftesting.com/t/test-cases-vs-no-test-cases/85331)
**Author:** [@shad0wpuppet](https://club.ministryoftesting.com/u/shad0wpuppet)\ **Replies:** 16\ **Last updated:** [9 July 2025 21:45 UTC](https://club.ministryoftesting.com/t/test-cases-vs-no-test-cases/85331 "2025-07-09T21:45:57Z")
Imagine kinda typical startup environment (generalized): You’re building a product from scratch. Lots of experiments and PoCs. You’re trying to get an MVP out for some users, beta first, then more. It’s an agile setup, … --- ## [How do you take notes at a conference/meetup?](https://club.ministryoftesting.com/t/how-do-you-take-notes-at-a-conference-meetup/84841)
**Author:** [@simon\_tomes](https://club.ministryoftesting.com/u/simon_tomes)\ **Replies:** 2\ **Last updated:** [22 May 2025 04:54 UTC](https://club.ministryoftesting.com/t/how-do-you-take-notes-at-a-conference-meetup/84841 "2025-05-22T04:54:23Z")
I like to quickly scribble down things from slides but also, write down things directly from the speaker if they stand out to me. :framed\_picture: Have a look at an example of Eamon Droko’s (@eamond15) notes during Le… --- ## [What types of requirements are often hidden?](https://club.ministryoftesting.com/t/what-types-of-requirements-are-often-hidden/80979)
**Author:** [@simon\_tomes](https://club.ministryoftesting.com/u/simon_tomes)\ **Replies:** 7\ **Last updated:** [28 February 2025 10:45 UTC](https://club.ministryoftesting.com/t/what-types-of-requirements-are-often-hidden/80979 "2025-02-28T10:45:30Z")
When starting a career in testing we often focus on the written requirements to guide our testing efforts. Yet over time, we discover hidden requirements are as just as important as explicit requirements. We develop ski… --- ## [What does testing debt look like and how do you keep on top of it?](https://club.ministryoftesting.com/t/what-does-testing-debt-look-like-and-how-do-you-keep-on-top-of-it/82332)
**Author:** [@simon\_tomes](https://club.ministryoftesting.com/u/simon_tomes)\ **Replies:** 0\ **Last updated:** [22 January 2025 15:36 UTC](https://club.ministryoftesting.com/t/what-does-testing-debt-look-like-and-how-do-you-keep-on-top-of-it/82332 "2025-01-22T15:36:19Z")
Tell me some stories about testing debt such as outdated scripts, unreviewed automation, hard-to-integrate new features, lack of unit tests and more. Some questions that might spark thoughts around testing debt: How d… --- ## [Capturing what has been automated](https://club.ministryoftesting.com/t/capturing-what-has-been-automated/82122)
**Author:** [@monsieurfrench](https://club.ministryoftesting.com/u/monsieurfrench)\ **Replies:** 7\ **Last updated:** [15 January 2025 14:41 UTC](https://club.ministryoftesting.com/t/capturing-what-has-been-automated/82122 "2025-01-15T14:41:54Z")
Morning, To those who have automated tests as a core part of their strategy and who still have “manual” regression testing also, I have a question. (perhaps the second point is irrelevant) Do you capture/document anywh… --- ## [What nifty tips and tricks do you have for finding testing opportunities in requirements?](https://club.ministryoftesting.com/t/what-nifty-tips-and-tricks-do-you-have-for-finding-testing-opportunities-in-requirements/80978)
**Author:** [@simon\_tomes](https://club.ministryoftesting.com/u/simon_tomes)\ **Replies:** 4\ **Last updated:** [30 November 2024 02:59 UTC](https://club.ministryoftesting.com/t/what-nifty-tips-and-tricks-do-you-have-for-finding-testing-opportunities-in-requirements/80978 "2024-11-30T02:59:28Z")
Does it say “should” but doesn’t say “shouldn’t”? Does it say “it may” instead of “it will”? There are plenty of places we can find opportunities to question and explore with requirements. What nifty tips and tricks d… --- ## [What different types of requirements have you used?](https://club.ministryoftesting.com/t/what-different-types-of-requirements-have-you-used/80816)
**Author:** [@simon\_tomes](https://club.ministryoftesting.com/u/simon_tomes)\ **Replies:** 1\ **Last updated:** [12 November 2024 20:32 UTC](https://club.ministryoftesting.com/t/what-different-types-of-requirements-have-you-used/80816 "2024-11-12T20:32:23Z")
Thinking back throughout your career, what are some of the types of requirements you’ve used to support your testing efforts? What development methodologies typically supported those types of requirements? How did the r… --- ## [How do you document and communicate risks?](https://club.ministryoftesting.com/t/how-do-you-document-and-communicate-risks/80717)
**Author:** [@simon\_tomes](https://club.ministryoftesting.com/u/simon_tomes)\ **Replies:** 8\ **Last updated:** [8 November 2024 15:39 UTC](https://club.ministryoftesting.com/t/how-do-you-document-and-communicate-risks/80717 "2024-11-08T15:39:10Z")
Is it a risky business to document risks? :sweat\_smile: I’d like to hear your anecdotes and stories. How do you document and communicate risks? How do you tailor risks to the appropriate audience? What forms of docume… --- ## [How do you document your impact at work?](https://club.ministryoftesting.com/t/how-do-you-document-your-impact-at-work/80008)
**Author:** [@cassandrahl](https://club.ministryoftesting.com/u/cassandrahl)\ **Replies:** 23\ **Last updated:** [27 October 2024 14:08 UTC](https://club.ministryoftesting.com/t/how-do-you-document-your-impact-at-work/80008 "2024-10-27T14:08:32Z")
When it comes to career development and advocating for yourself at the time of performance reviews, experience has shown me two things: It’s not what you’ve done, it’s what you’ve documented You need to start early and… --- ## [What details do you put in framework documentation](https://club.ministryoftesting.com/t/what-details-do-you-put-in-framework-documentation/69250)
**Author:** [@mwinteringham](https://club.ministryoftesting.com/u/mwinteringham)\ **Replies:** 5\ **Last updated:** [25 July 2024 15:47 UTC](https://club.ministryoftesting.com/t/what-details-do-you-put-in-framework-documentation/69250 "2024-07-25T15:47:15Z")
Hello once again, I’m looking to find out a bit more about framework documentation, specifically: What details do you put in framework documentation Documentation can sometimes feel unnecessary, but if we get the ri… --- ## [Software Test Plan (STP) document](https://club.ministryoftesting.com/t/software-test-plan-stp-document/74460)
**Author:** [@liormof](https://club.ministryoftesting.com/u/liormof)\ **Replies:** 7\ **Last updated:** [11 March 2024 16:54 UTC](https://club.ministryoftesting.com/t/software-test-plan-stp-document/74460 "2024-03-11T16:54:08Z")
I am writing an STP document for a “library” program. One of the tested functions is denying deletion of an already borrowed book. How extensive should I be when describing how I am going to test this function in the S… --- ## [Three Reasons Why Your Test Plan Is Failing](https://club.ministryoftesting.com/t/three-reasons-why-your-test-plan-is-failing/69023)
**Author:** [@simon\_tomes](https://club.ministryoftesting.com/u/simon_tomes)\ **Replies:** 4\ **Last updated:** [23 February 2024 09:05 UTC](https://club.ministryoftesting.com/t/three-reasons-why-your-test-plan-is-failing/69023 "2024-02-23T09:05:59Z")
Ministry of Testing launched a LinkedIn newsletter at the start of 2023. Each newsletter article has got a lot of attention which is awesome. Each one celebrates someone in the community who has produced something that… --- ## [Retracting testing content - what do you think?](https://club.ministryoftesting.com/t/retracting-testing-content-what-do-you-think/73936)
**Author:** [@ipstefan](https://club.ministryoftesting.com/u/ipstefan)\ **Replies:** 2\ **Last updated:** [12 February 2024 16:15 UTC](https://club.ministryoftesting.com/t/retracting-testing-content-what-do-you-think/73936 "2024-02-12T16:15:41Z")
I recently saw an article published in Nature magazine about a new record of 10000 retractions of research papers in 2023. Integrity experts say that this is only the tip of the iceberg. More than 100,000 in the last 2… --- ## [Do you add code documentation to your automated checks?](https://club.ministryoftesting.com/t/do-you-add-code-documentation-to-your-automated-checks/69720)
**Author:** [@mwinteringham](https://club.ministryoftesting.com/u/mwinteringham)\ **Replies:** 18\ **Last updated:** [18 September 2023 09:07 UTC](https://club.ministryoftesting.com/t/do-you-add-code-documentation-to-your-automated-checks/69720 "2023-09-18T09:07:39Z")
We have a new article out from @yaniqued in which she shares her thoughts on the value of code documentation: I really liked the points @yaniqued made in this article and it made me think more about the value of code… --- ## [Tools & ideas to represent and document testing framework](https://club.ministryoftesting.com/t/tools-ideas-to-represent-and-document-testing-framework/67313)
**Author:** [@ralucapopa](https://club.ministryoftesting.com/u/ralucapopa)\ **Replies:** 1\ **Last updated:** [5 May 2023 12:54 UTC](https://club.ministryoftesting.com/t/tools-ideas-to-represent-and-document-testing-framework/67313 "2023-05-05T12:54:08Z")
Hello, I’ve been looking around to find ideas about how to document the automated tests from project. There are multiple layers: both UI and API tests test reports generated test data setup for each environment test c… --- ## [Is it common for testers to write the product documentation?](https://club.ministryoftesting.com/t/is-it-common-for-testers-to-write-the-product-documentation/56610)
**Author:** [@wrenarf](https://club.ministryoftesting.com/u/wrenarf)\ **Replies:** 17\ **Last updated:** [21 September 2022 06:05 UTC](https://club.ministryoftesting.com/t/is-it-common-for-testers-to-write-the-product-documentation/56610 "2022-09-21T06:05:07Z")
Hello! In our organization, we have SDET and manual testers. Our manual QA testers are responsible for all acceptance testing which is primarily exploratory. We’re starting to dabble in written test cases but haven’t dec… --- ## [How do you structure your documentation repositories in Confluence (or similar)](https://club.ministryoftesting.com/t/how-do-you-structure-your-documentation-repositories-in-confluence-or-similar/61733)
**Author:** [@piconyannyan](https://club.ministryoftesting.com/u/piconyannyan)\ **Replies:** 2\ **Last updated:** [17 August 2022 03:19 UTC](https://club.ministryoftesting.com/t/how-do-you-structure-your-documentation-repositories-in-confluence-or-similar/61733 "2022-08-17T03:19:34Z")
I am tasked to propose a base structure for the Confluence page for our own team. I tried searching for this topic here but seems to be something that hasn’t been discussed. How do you structure your documentation in th… --- ## [Regression Testing Guidelines](https://club.ministryoftesting.com/t/regression-testing-guidelines/59684)
**Author:** [@mirza](https://club.ministryoftesting.com/u/mirza)\ **Replies:** 4\ **Last updated:** [2 June 2022 12:56 UTC](https://club.ministryoftesting.com/t/regression-testing-guidelines/59684 "2022-06-02T12:56:23Z")
Hi all, recently I took on a new freelance project, a very interesting new mobile app. They are asking if I could write a guideline about how it’s done. I got a general idea of what I should put there - I went through th… --- ## [How do you learn how software works?](https://club.ministryoftesting.com/t/how-do-you-learn-how-software-works/58845)
**Author:** [@simon\_tomes](https://club.ministryoftesting.com/u/simon_tomes)\ **Replies:** 0\ **Last updated:** [10 May 2022 07:00 UTC](https://club.ministryoftesting.com/t/how-do-you-learn-how-software-works/58845 "2022-05-10T07:00:41Z")
It might seem like a straightforward question yet it opens up many answers and directions. https://twitter.com/ministryoftest/status/1521600741617684480?s=20&t=TC-n94nBS7r3FQzMQLcjXA Some responses: Working together … --- ## [How to store and manage session notes (in confluence)?](https://club.ministryoftesting.com/t/how-to-store-and-manage-session-notes-in-confluence/52917)
**Author:** [@trevor7](https://club.ministryoftesting.com/u/trevor7)\ **Replies:** 7\ **Last updated:** [6 September 2021 10:14 UTC](https://club.ministryoftesting.com/t/how-to-store-and-manage-session-notes-in-confluence/52917 "2021-09-06T10:14:12Z")
How can I store session notes on confluence and make them easily manageable? Currently, I am writing the session notes on google docs, save the file in .txt format then upload it to Confluence. This is not the most eff… --- ## [Is anyone doing UX for APIs?](https://club.ministryoftesting.com/t/is-anyone-doing-ux-for-apis/50663)
**Author:** [@fullsnacktester](https://club.ministryoftesting.com/u/fullsnacktester)\ **Replies:** 17\ **Last updated:** [14 June 2021 15:53 UTC](https://club.ministryoftesting.com/t/is-anyone-doing-ux-for-apis/50663 "2021-06-14T15:53:26Z")
APIs may be an agreed way for applications to communicate, but we should be building them for humans. Why? Humans test the API. Humans write the applications that will use the API. Humans use the applications that use… --- ## [Documenting Code Logic for QA](https://club.ministryoftesting.com/t/documenting-code-logic-for-qa/51045)
**Author:** [@kayleeb](https://club.ministryoftesting.com/u/kayleeb)\ **Replies:** 6\ **Last updated:** [11 June 2021 07:34 UTC](https://club.ministryoftesting.com/t/documenting-code-logic-for-qa/51045 "2021-06-11T07:34:03Z")
Hello, all. I’m wondering if anyone has experience with documentation and knowledge transferring, namely from developers to QA. One thing that slows down my QA team is when we don’t know the coded logic behind something… --- ## [How do you present documents and reports related to testing to your team and stackholders?](https://club.ministryoftesting.com/t/how-do-you-present-documents-and-reports-related-to-testing-to-your-team-and-stackholders/50979)
**Author:** [@emna\_ayadi](https://club.ministryoftesting.com/u/emna_ayadi)\ **Replies:** 5\ **Last updated:** [9 June 2021 11:58 UTC](https://club.ministryoftesting.com/t/how-do-you-present-documents-and-reports-related-to-testing-to-your-team-and-stackholders/50979 "2021-06-09T11:58:05Z")
Hi All, Following the agile manifesto, everyone want less amount of documentation working software over comprehensive documentation My questions: if you want to improve the documentation process, what kind of docu… --- ## [Functional testing scenarios](https://club.ministryoftesting.com/t/functional-testing-scenarios/49981)
**Author:** [@roger89](https://club.ministryoftesting.com/u/roger89)\ **Replies:** 1\ **Last updated:** [7 May 2021 06:48 UTC](https://club.ministryoftesting.com/t/functional-testing-scenarios/49981 "2021-05-07T06:48:03Z")
So thing is about the documentation of FTS. Is it mandatory to use an excel file?is there any simple tools for free? i checked TestPad it is very user friendly. More, should we adopt same boring and numerous columns and … --- ## [Test Plan / Test Exit Report Combined?](https://club.ministryoftesting.com/t/test-plan-test-exit-report-combined/48683)
**Author:** [@lindsey.a.gibbs](https://club.ministryoftesting.com/u/lindsey.a.gibbs)\ **Replies:** 6\ **Last updated:** [12 April 2021 13:01 UTC](https://club.ministryoftesting.com/t/test-plan-test-exit-report-combined/48683 "2021-04-12T13:01:38Z")
I want to completely renew my testing documentation and it raised a question “Why do we need a separate test plan and test exit report”? Has anyone combined these 2 documents to make just one, if so how? I was wondering …