My Projects: Realisation documents

The build part of this collection houses five types or documents:

  • (system) procedures/tasks

  • technical processes

  • technical data items

  • layouts

  • procedure/program descriptions

The structure of the site and the navigation over its parts is described elsewhere. What follows here is more about the general contents of these types of documents.

System procedure/task

This type of document can be used to describe the technical counterpart of a user transaction. It can also be used as a grouping of technical processes that are meant to work together like in a batch job.

The following pieces of information are defined:

  • a title

  • a short (one line) description

  • a description of the purpose

  • a description of the timing

  • a description of how this is supposed to transpire

This can reference to functional (user) task (not to functional processes?); it can be referenced to from technical processes (as in they are meant to implement this task)

Technical process

This type of document is meant to hold the technical translation/implementation of a functional process or part(s) of one.

The following pieces of information are defined:

  • a title

  • a short (one line) description of the purpose

  • a description of the entry situation (at the start of the process)

  • a description of the result situation (after the process has run its course)

  • a description of the (course of) the process itself

  • a description of additional stuff, like the environment the process takes place in

This can reference to functional processes, technical (system) tasks and other technical processes; can be referenced to from other technical processes, data items, layouts and programs

Technical Data Item

This type of document is meant to hold the technical translation/implementation of a part of the functional data model (as described in the entity document type). It can also be used for additional data structures that are needed for technical reasons.

The following pieces of information are defined:

  • a name for the data item

  • a short (one line) description of its function

  • a description of its lifespan

This can reference to data model entity and technical process; no references from other documents

Layout

This type of document is meant to describe the visual appearance of part of the application to build, as in a document or screen

The following pieces of information are defined:

  • a name

  • a short (one line) description of its purpose or function

  • a link to an uploaded version of an example document

  • a longer description

This can reference to functional (not technical?) tasks and technical processes; no references from other documents

Procedure/program

This type of document is meant to contain the description of a component to build. It can also be used to describe how something is not realized in the form of software but procedural stuff like work instructions.

The following pieces of information are defined:

  • a name

  • a short (one line) description of the purpose

  • a description of the input (entry situation, calling arguments)

  • a description of the output (result situation, error messages etc.)

  • a description of the processing

  • a description of any peculiarities that need to be mentioned

  • a description of how (when/in what situations) to test this component

  • a description of cases to test this component for

This can reference to technical processes; no references from other documents