Stories

As a developer I want to define application features and track which have been already implemented, verified and documented.

Stories, which implement the L3 metadata, can be used to track implementation, test and documentation coverage for individual features or requirements. Thanks to this you can track everything in one place, including the project implementation progress.

In addition to the attributes defined here, stories also support common Core attributes which are shared across all metadata levels.

Examples:

story:
    As a user I want to see more detailed information for
    particular command.
description:
    Different verbose levels can be enabled by using the
    option several times.
example:
  - tmt test show -v
  - tmt test show -vvv
  - tmt test show --verbose
link:
  - implemented-by: /tmt/cli.py
  - documented-by: /tmt/cli.py
  - verified-by: /tests/core/dry
priority: must

example

Instructive examples of real-life usage.

One example is worth thousand words. Providing a few, well selected, examples helps to understand quickly and get inspiration for initial experimenting.

Examples:

example: tmt run discover

Status: implemented

story

User story describing the feature to be implemented

This is a required attribute. Each story has to define or inherit a story definition.

Examples:

story:
    As a user I want the application to do this and that
    so that I can achieve this and that.

Status: implemented

title

Title to be used when generating documentation

As a story writer I want to specify a title which should be used when generating online documentation from user stories.

When converting user stories into the reStructuredText format in order to render content into online documentation it is sometimes useful to provide a custom user story title rather then using the story name which can be too short to describe well the section content.

Examples:

title: Nice title

Status: implemented