Template:UseCase

From W3C eGovernment Wiki
Revision as of 10:52, 22 December 2008 by Josema (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search


Below, a very small example to show how this use case template can be used on your own Use Case pages. The rationale for this template is explained at the Use Case Template page.

To define a new use case, create a new Wiki page by typing its intended name just after the eGov IG Wiki's URL:

http://www.w3.org/2007/eGov/IG/wiki/<page-name-here>

where <page-name-here> should be consistent: Use Case N - <short-name>.

Make sure you are logged in, and click the 'Edit' menu option at the top of the page.

Copy and paste the code below into your new page.

{{UseCase
|id = the use case identifier
|name = the name of the use case
|author = the name of the author(s)
|problem_definition = the problem definition of this use case
|target_population = the target population for this use case
|description= the description of this use case
|target_software= the target software for this use case
|problems= what are the problems related to this use case?
|related= related standards and initiatives
|prioritization= the prioritization of this use case}}

If you now click the 'Preview' button, the preview of your page will show the following format:


Use Case: the name of the use case

Identifier

the use case identifier

Author(s)

the name of the author(s)

Problem Definition

the problem definition of this use case

Target population

the target population for this use case

Description

the description of this use case

Target software

the target software for this use case

Identified problems or limitations

what are the problems related to this use case?

Related initiatives

related standards and initiatives

Priorization

the prioritization of this use case


You can now make the appropriate changes to the use case by replacing the text behind the equals ('=') sign with the information regarding the use case. For example replace the string 'the use case identifier' with 'UC-EGIG-SID-001' etc.

The template code shown in the next section should be ignored, this code is used to generate a uniform layout for each use case and ensures that all use cases are listed in the use case category page. Modifications to this code will affect all use cases!

A more elaborate example of what a use case specified using the template looks like can be found at Use Case Example.


IGNORE THE CODE BELOW THIS

Use Case: {{{name}}}

Identifier

{{{id}}}

Author(s)

{{{author}}}

Problem Definition

{{{problem_definition}}}

Target population

{{{target_population}}}

Description

{{{description}}}

Target software

{{{target_software}}}

Identified problems or limitations

{{{problems}}}

Related initiatives

{{{related}}}

Priorization

{{{prioritization}}}