#63 Write Documentation for end users

[Andreas Mangold]

The structure of the wiki pages, starting from [wiki:User's Guide] should be roughly as outlined below. See [wiki:Documentation Guidelines].

• Release Notes

• Installation

  • Prerequisites
  • Download and install ZIP-file
  • Adjust paths
  • Have a look at the documentation and the sample output
• Getting started
  • Write a simple test
  • Execute the test
  • Look at the results
• Architectural overview
  • Concepts of unit tests
  • Test database
  • Organisation of programs to be tested
  • Execution logic for test scenarios
  • Structure of a test scenario
  • Report generation
• Usage
  • Set up your testing environment
    • SASUnit macro programs
    • Units under test
    • Test scenarios
    • Static test data and specifications
    • Output
    • Command scripts and main SAS control program
  • Write your test scenarios
    • Macros for the setup of test scenarios
    • Test for values of macro variables (assertEquals)
    • Test for values of dataset columns (assertColumn)
    • Test for contents of libraries (assertLibrary)
    • Test for error and warning messages in the log (assertLog)
    • Test for certain messages in the log (assertLogMsg)
    • Integrate manual inspection of visual output (assertReport)
  • Get more control over test scenario execution
    • Control the environment for test scenarios (autoexec, config)
    • Use static test data and reference data
    • Control which test scenarios should be executed
    • How to work with relative and absolute paths
• Reference
  • Macros for control of test execution
  • Macros for setup of test scenarios
  • Macros for assertions
  • Examples
  • Schema of test database

[Andreas Mangold]

• Description has changed:

Diff:

--- old
+++ new
@@ -1,4 +1,4 @@
-The structure of the wiki pages could be roughly as follows:
+The structure of the wiki pages, starting from [wiki:User's Guide] should be roughly as outlined below. See [wiki:Documentation Guidelines].


 * Release Notes

[Andreas Mangold]

task [#85] Write User Documentation for chapters Installation and Getting Started

[Klaus Landwich]

Getting started inside Users Guide is completed