.. Copyright (C) ALbert Mietus, SoftwareBeterMaken.nl; 2014. Part of Pathways project -*- coding: utf-8 -*-

=======================
Framework documentation
=======================


Pathways: a test-guide for iterative developed software
=======================================================

This Pathways-framework is a reference implementation for effectively verifying (or *testing*) the
correct behaviour of a product. Especially during iterative development, like scrum or *'Integrated
Agile'*, the developed product changes constantly, as does the features (and other requirements) of
the product. So, it is vital to constantly verify all existing and new features. This has to be
automated else the load of manual testing will grow quickly above the capability of the team.

Also the maintenance of all those :term:`Automated Test Script`\s (or :term:`ATS`) should be
minimal. This is possible by using known software-design-principles, like locality.

Overview
========

The two images give an global overview of the pathways-package; they are automatically generated from the code with `pyreverse`


UML class diagram
-----------------

.. image:: ./pyreverse/classes_Pathways_Framework.svg

UML packages diagram
--------------------

.. image:: ./pyreverse/packages_Pathways_Framework.svg


Design
======
.. toctree::
   :maxdepth: 2

   Design/index



The packages
============

.. toctree::
   :maxdepth: 1
   :glob:

   apidoc/*