From 11a00692753622d1865e0c7482fa72fef67a0e14 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Fri, 3 May 2019 21:53:14 +0300 Subject: Add: beginnings of Saga documentation --- Makefile | 5 +++-- jt1.pdf | Bin 156345 -> 156345 bytes saga.yarn | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 58 insertions(+), 2 deletions(-) create mode 100644 saga.yarn diff --git a/Makefile b/Makefile index a7194c7..cd287a4 100644 --- a/Makefile +++ b/Makefile @@ -1,10 +1,11 @@ -all: muck1.pdf muck2.pdf muck3.pdf jt1.pdf jt2.pdf +all: muck1.pdf muck2.pdf muck3.pdf jt1.pdf jt2.pdf saga.pdf %.pdf: %.yarn pandoc -o $@ $< \ --number-sections \ - --template eisvogel.tex \ --toc \ + --top-level-division=chapter \ + -Vdocumentclass:report \ -Vtitlepage:true \ -Vgeometry:a4paper \ -Vfontsize:12pt \ diff --git a/jt1.pdf b/jt1.pdf index 875ba57..d98154c 100644 Binary files a/jt1.pdf and b/jt1.pdf differ diff --git a/saga.yarn b/saga.yarn new file mode 100644 index 0000000..3e60340 --- /dev/null +++ b/saga.yarn @@ -0,0 +1,55 @@ +--- +title: Saga — acceptance testing +author: +- Lars Wirzenius +- Daniel Silverstone +version: WIP +keywords: +- automated acceptance testing +- scenario testing +- gherkin +- cucumber +abstract: | + Saga is a tool that supports acceptance testing in two ways: it is a + way to implement and run automated acceptance tests, and also + presents the acceptance test suite to non-expert readers as a + human-readable text document. + + This document explains Saga and its input language. +... + +# Introduction + +Saga is a tool for acceptance testing of software. This means it helps +software developers and teams to make sure their software fulfils the +acceptance criterita for the software. Such criteria may come from +users, the developers, their employers, or other elsewhere. + +Saga is specifically mean for automated acceptance testing. It takes a +two-pronged approach, where it lets developers implement automated +tests for all the acceptance criteria they have, and runs the tests. +On the other hand, Saga also produces a PDF file, which documents the +automated tests for non-technical stakeholders. + +More concretely, Saga helps developers implement and document their +automated acceptance tests in a way that, at the same time, helps the +developers automatically test their software, and write documention +for the tests in way that doesn't require programming knowledge to +understand. + +Saga is meant to be a tool for developers, who use it to produce a +document, which is meant to facilitate communication between various +shareholders of the software being developed. + +Saga's overall working principle is that the tests are implemented and +documented in a number of source files, which Saga reads to execute +tests, and to produce a PDF document for non-developer consumption. + +# Saga architecture + +* What is the overall Saga architecture? + +# Saga input language + +* What is the overall approach to the Saga input language? +* -- cgit v1.2.1