Case Docu Standard

Goals

• Simplify teach in
• reduced effort (e.g. newcomer, contributor, project administrator)
• make participants feel quickly comfortable and secure

Requirements

• Split the documented system into subsystems
• provide information compactly, concise and incremental
  • do not interweave subsystems
  • do not mention higher grade constructs to explain lower grade ones
  • test delivered knowledge (or results, e.g. in case of installation)
• provide dedicated resources for participant roles (user, developer)
• provide dedicated resources for special contexts (e.g. Product, Project)

Process/Guidelines?

• Simplify Subsystems before they are documented.
• Simplify Complex Documentation by simplifying the documented system.

Examples

Documentation for an incremental a setup process

• Install the programming language, run a test
• Install a Library, run a test
• Install the Application, run a test
• Install an extension for speedup, run a test
• Run a full-system-test