Git Product home page Git Product logo

union's Introduction

Union

Exploratory testing with SBTM and Markdown.

Overview

Union is a simple, formatted outline that favors convention over new syntax. In this way, your testing documentation can take advantage of popular text editors and existing Markdown tools to display your notes in the way that is right for you.

File Format

The Markdown file is broken up into 4 sections:

Section Description
YAML Header (Metadata) The who, what, why, when and how of the session. You can even add your own fields!
Name / Description A high-level, one sentence description of the thing you're testing in the session.
Notes The heart of the document; describes your testing in as much detail as you require.
Debrief Notes from discussions with test managers or fellow testers about the content of the session.

Conventions

YAML Header (Metadata)

  • The "Testers" and "Tags" fields are comma-separated strings.
  • The prefered format for the "Start" and "Stop" fields is YYYY-MM-DD HH:MM, but any format that's easily parsable by a programming language is appropriate.

Notes

  • Notes are taken in an outline format.
  • Indicate bugs with strong emphasis, using double asteriks or double underscores.
  • Indicate issues (problems or observations that require investigation) with emphasis, using single asteriks or single underscores.
  • Include a parenthesis wrapped timestamp when noting bugs and issues. This helps put the item in context within the testing session. See the template for examples.
  • Link issues that are filed in a bug tracker with a reference-style link.

Miscellaneous

The charter template is from Elisabeth Hendrickson's excellent book Explore It!.

There's a Trello Project Board for this thing.

Another Union.

union's People

Contributors

kyleobrien avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.