My Projects: User documents

The User part of this collection houses four types of documents:

  • specifications/requirements

  • reference material and other documents

  • change requests

  • problem reports

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.

specifications/requirements

These documents contain directives describing either components to be built or conditions these have to fulfill.

The following pieces of information are defined for specifications:

  • a title

  • a short (one line) description

  • a description of the desired functionality

  • a description of how it should look

  • a description of the output it should produce

  • a short (one line) description of the supposed benefits

  • a short (one line) description of the allowed costs

  • a description of whatever else needs to be described

Specification/requirement documents don't reference to any documents; they can be referenced to from functional (user) tasks and functional processes, in the sense that these intend to realize the specifications or fulfill the requirements.

reference material and other documents

This type of document offers the possibility to enter an unspecified text, and/or provide a reference to a ready-made document. A title and a short description can be entered in both cases.

The following pieces of information are defined:

  • a title

  • a short (one line) description

  • a link to an uploaded document

  • a free text to enter

There are no references defined to or from these documents.

change requests

This type of document can be created when the existing functionality is not sufficient. It is similar to a specification/requirement, but it is meant to expand on it instead of describe something new.

The following pieces of information are defined:

  • a sequence number that is automatically generated

  • a creation date (not shown on screen)

  • an indication of readiness

  • a completion date (not shown on screen)

  • a short (one line) description of the request

  • a full description

  • room for additional remarks

  • the database key of the related action item in the ticket registration (not shown on screen)

  • the action number as shown on the ticket registration screens

Change requests don't reference to any documents; they can be referenced to from functional (user) tasks, functional processes and data model entitities - in the sense what this request is a change or addition for.

problem reports

This type of document can be created when the existing functionality isn't working properly according to the specifications/requirements that describe it.

The following pieces of information are defined:

  • a sequence number that is automatically generated

  • a creation date (not shown on screen)

  • an indication of readiness

  • a completion date (not shown on screen)

  • a short (one line) description of the request

  • a full description

  • room for additional remarks

  • the database key of the related action item in the ticket registration (not shown on screen)

  • the action number as shown on the ticket registration screens

There are no references defined to or from problem reports (for now).