Guide

From PATSWiki

Rolv Bræk / Haldor Samset / Frank Alexander Kraemer


We are missing a description of the steps from the initial ideas of a service towards the individual state machines. We will update the Wiki page with a description of a method. This includes the modeling with collaborations and steps further down to state machines. We will describe a main map for the steps. Then we will describe each step and how each step is done and tested. We will also describe the necessary UML modeling elements. Should be ready for the new students starting august 15th 2006.


The Essentials of Service Engineering

- A Reference Guide -

How to write this guide?

  • Style

We should write very short and concise. The guide should be more a reference than a textbook. The focus should in the first place be to cover an entire approach from a domain problem to the design of the state machines completely.

  • Structure

We should use the possibility a wiki gives us. This means that we write small chapters on rather narrow subjects and link them with overview pages. Several overview pages can be linked to the same detail pages.

  • Process Overview page - A page that lists which steps one should do in a sequence.
  • Process Step page - For each step we can have an extra page pointing to the needed action in the tools, the decisions a developer has to do, links to external references.
  • UML Elements - A page listing all UML elements that are relevant for us and that point to one page for each UML element. Dynamic links in Ramses can also point to these pages.

Access to the Guide

  • Online - As a wiki the guide will be based on its online presentation on the web. We can easily update it and collaborate even on the same chapters.
  • From the tool - Ramses offers in its context sensitive help also links to exertnal resources, for example in the wiki. Pressing a certain element would open the page about that element, for example.
  • Printed - We could produce a PDF-version of the Wiki pages for the guide that are linked in the same way as the wiki. Similar to the manual of TIMe.