SolutionsUseCase Entry

From Earth Science Information Partners (ESIP)
Revision as of 14:27, May 8, 2007 by Stuart Frye (Sfrye) (talk | contribs) (→‎Page name format)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Return to: Use_Cases


How to begin a new use case description

Begin a new Use Case by editing the Earth Science Solutions section of the Use_Cases page. Add a page name for the new Use Case as follows:

Append after
* Use Case 1:  SolutionsUseCase_AirQuality-Atmosphere_Smoke_1a
<* Use Case 2:  [[SolutionsUseCase_<new application area_subarea_referenceNumber>]]>


Follow the page naming conventions described in the next section.

Wiki page naming convention

Page name format

We are suggesting that authors of new use cases create a wiki page named according to the following scheme:

Naming Format
SolutionsUseCase_<ApplicationArea>_<SubArea>_<ReferenceNumber>
Example usage
SolutionsUseCase_AirQuality-Atmosphere_Smoke_1a
SolutionsUseCase_Health-Disaster_Fire-Wildfire-Observation-Coverage_1a

Page name components

Where:

SolutionsUseCase
All Earth Science Solutions wiki pagenames should begin with the string "SolutionsUseCase"
<ApplicationArea>
Please select an application area from the following list or use an alternative ESIP relevant name - surround ApplicationArea with underscores and no spaces: {AirQuality-Atmosphere, Climate-Weather, Coasts-Oceans, Ecology-CarbonCycle, Health-Disaster, Land-Geosciences, Water-Energy}
<SubArea>
The specific SubArea will be under the authority of the appropriate Federation Application Area Working Group, usually a short descriptive name.
<ReferenceNumber>
The specific ReferenceNumber will be also be under the authority of the appropriate Federation Application Area Working Group, usually of the following form: {1, 1a, 2, 3} Note that more detailed lineage information will be found in the detailed description of the Use Case.

Template for Use Case Entry

The following template provides the structure for a complete Use Case. Begin the process by editing the template, selecting the entire text, and pasting it into the new wiki page that you created in step 1 above. Normally you would only be expected to complete the first "plain language" description before recruiting domain experts for the more detailed sections that follow.

SolutionsUseCase_Template