rich glossary templa by housework

VIEWS: 21 PAGES: 19

rich glossary templa

More Info
									                   [project or system name]

                           Rich Glossary


                            December 4, 2007



Template Usage

  1. Before installing, tailor to add, remove, and change content to suit the
     usage environment.

     Sample entries are included to help those unfamiliar with rich
     definition patterns. When authors are familiar, the examples can be
     removed from a developing glossary and even from the template itself.

  2. A definition author will select a suitable pattern for a new term and
     copy and paste the pattern’s template from the appendix.

     Remember that plain definitions define words using phrases and
     sentences, while rich definitions define words (unmodified nouns),
     noun and verb phrases, and sentences (events) using 7 rich definition
     patterns.

  3. Plain definitions, acronyms, and sources have no templates.

  4. Terms can be grouped by:
        a. domain (i.e., application terms (order, customer)
                         vs. system terms (password, administrator))
        b. parts of speech
        c. all or none of the above

  5. Consider creating 2 entries for each modified noun or verb – the first
     uses the appropriate definition and the second points to the first. For
     example, the modified noun “potential customer” would have an entry
     for “customer, potential” and “potential customer”.

  6. Template entries use Heading 3 styles for the basic term and
     Heading 4 styles for context to enable Word’s autoindexing to display
     them in the Table of Contents.




                                    -1-
                                           Table of Contents

[Insert TOC here]

Terms .................................................................................................................................. 4
  Nouns, Unmodified ......................................................................................................... 4
  Nouns, Modified ............................................................................................................. 4
    Requirements Risk ...................................................................................................... 4
  Verbs, Post-modified ...................................................................................................... 4
  Verbs, Premodified ......................................................................................................... 4
  Events .............................................................................................................................. 4

Acronyms ............................................................................................................................ 5
    RRM............................................................................................................................ 5

Pattern Appendix ................................................................................................................ 6

   Entity Profiles ................................................................................................................. 7
     Example ...................................................................................................................... 7
     copy of a book (related entities)................................................................................. 7
     Template ..................................................................................................................... 8
     [modified or unmodified noun]................................................................................... 8

   Derived Values................................................................................................................ 9
     Examples ..................................................................................................................... 9
     days after sale .............................................................................................................. 9
     total of orders for salesperson-id in year-id ................................................................ 9
     city tax-rate in state ................................................................................................... 10
     Template ................................................................................................................... 10
     [modified noun] ........................................................................................................ 10

   Derived Conditions ....................................................................................................... 11
     Examples ................................................................................................................... 11
     potential customer for our new web-based order management system .................... 11
     bought-many-services-last-year ................................................................................ 11
     bought-services-A-and-B-last-year ........................................................................... 11
     bought-a-lot-of-service-C-last-year .......................................................................... 11
     operator class of the primary (PO) of a vehicle ........................................................ 12
     Template ................................................................................................................... 12
     [modified noun] ........................................................................................................ 12




                                                                 -2-
Quality Profiles ............................................................................................................. 13
  Example .................................................................................................................... 13
  Learnability of the new web-based order management system ................................ 13
  Template ................................................................................................................... 14
  [modified noun or verb] ............................................................................................ 14

Action Contracts ........................................................................................................... 15
  Examples ................................................................................................................... 15
  Process order ............................................................................................................. 15
  Assign seat to passenger with reservation ................................................................ 16
  Template ................................................................................................................... 16
  [post-modified verb] ................................................................................................. 16

Derived Tasks ............................................................................................................... 17
  Examples ................................................................................................................... 17
  without conditions..................................................................................................... 17
  arrange trip ................................................................................................................ 17
  with conditions .......................................................................................................... 17
  arrange air travel ....................................................................................................... 17
  Template ................................................................................................................... 17
  [post-modified verb] ................................................................................................. 17

Event Profiles ................................................................................................................ 18
  Example .................................................................................................................... 17
  Identify potential customers ...................................................................................... 17
  Template ................................................................................................................... 18
  [event name].............................................................................................................. 19




                                                           -3-
                                   Terms


[Use the pattern templates found in the appendix. Put terms in alphabetical
order within category.]


Nouns, Unmodified



Nouns, Modified


   Requirements Risk
      the potential for significant harm or loss rooted in defective
      requirements

      Source(s)
         1. Managing Requirements Risk at www.clearspecs.com




Verbs, Post-modified




Verbs, Premodified




Events




                                     -4-
                               Acronyms


[Put acronyms in alphabetical order.]


IOK
      Imprecision is OK

RRM
      Requirements Risk Management




                                    -5-
                           Pattern Appendix

Pattern use by parts of speech

     Nouns, Unmodified
          Entity profiles

     Nouns, Modified
          Entity profiles
          Derived conditions
          Derived values
          Quality profiles

     Verbs, Post-modified
          Action contracts
          Derived tasks

     Verbs, Premodified
          Derived conditions
          Action contracts
          Quality profiles

     Events
          Event profiles




                                 -6-
Entity Profiles


Example

     copy of a book

       Attribute Names         Data Types    Occurrences
     Copy Id                    Identifier
     Book Id                    Identifier
     Supplier Id                Identifier
     Acquisition Date             Date

     Checkout Period            Number

     Loaned Count               Number
     Availability Status          Code

     Availability Start Date      Date

     Borrower Ids               Identifier   Multiple (10)


      Relationship Type          Entity

               M:1                Book
               M:1               Library
               M:1              Supplier
               M:N               Patron


     Source(s):


     Comment(s):




                                  -7-
Template

     [modified or unmodified noun]


      Attribute Names      Data Types   Occurrences




      Relationship Type      Entity




     Source(s):


     Comment(s):




                              -8-
Derived Values


Examples

  Formulas

     days after sale

     = (current date – sale date)

     Source(s):


     Comment(s):




     total of orders for salesperson-id in year-id

     =   SUM OF values FROM orders
         WHERE (sales contact = salesperson-id) AND (year = year-id)

     Source(s):


     Comment(s):




                                    -9-
  Tables

     city tax-rate in state

       state       city       tax-rate
        AZ                      .025
        MN        Edina         .038

     Source(s):


     Comment(s):




Template

     [modified noun]


     [Formula or Table]


     Source(s):


     Comment(s):




                                       - 10 -
Derived Conditions


Examples

  Formulas


     potential customer for our new web-based order management
          systems

     = bought-many-services-last-year
          or bought-services-A-and-B-last-year
          or bought-a-lot-of-service-C-last-year


     bought-many-services-last-year

     = (total-invoiced-service-types > 5)


     bought-services-A-and-B-last-year

     = invoiced-for-service-A and invoiced-for-service-B


     bought-a-lot-of-service-C-last-year

     = (invoiced-amount-for-service-C > $500,000.00)


     Source(s):


     Comment(s):




                                  - 11 -
  Tables


   operator class of the primary (PO) of a vehicle

     subject      predicate     1             2      3       4
                     set
     PO age        integer     ≥ 25          < 25    24     < 24
                   ranges                    ≥ 21   or 23
     PO sex        [M, F]       -             M      M       F

     PO
     marital       [M, S]       -             M      S       -
     status
     Annual        integer    > 4800
     business      ranges       km            -       -      -
     distance
     Operator
     class                     07            09      13     13



     Source(s):


     Comment(s):


Template

     [modified noun]


     [Formulas or Table]


     Source(s):


     Comment(s):




                                    - 12 -
Quality Profiles


Example


Learnability of the new web-based order management system


   ID                      QP-1.1


   ATTRIBUTE               Learnability – ease of learning to use the system
                           effectively

   MEASURE                 Time (in minutes) needed by novice subjects
                           (with no prior exposure to our website and fewer
                           than 6 months experience with web applications)
                           to successfully complete a 1-item order (aided
                           only by the online help system)

   METHOD                  Time at least 100 novice subjects during user
                           interface testing

   MUST                    Less than 10 minutes for at least 80% of the
                           novice subjects
   GOAL                    Less than 7 minutes for at least 80% of the
                           novice subjects
   Stretch                 Less than 5 minutes for at least 80% of the
                           novice subjects

   Past [current system] 11 minutes for 80% of all users  recent site
                         statistics


     Source(s):


     Comment(s):




                                 - 13 -
Template

  [modified noun or premodified verb]


  ID


  ATTRIBUTE


  MEASURE



  METHOD


  MUST

  GOAL

  Stretch


  Past [current system]



     Source(s):


     Comment(s):




                              - 14 -
Action Contracts


Examples


     Process order

       Order       On Hand    On Hand vs.          Post-Conditions
      Quantity     Quantity      Order
       Invalid       ---                    Invalid quantity reported

        Valid        Out        [Short]     Backorder created

        Valid        In          Short      Backorder created
                                            & Partial order ticket created

        Valid        In         Enough      Full order ticket created



     Source(s):


     Comment(s):




                               - 15 -
  Assign seat to passenger with reservation

     Rule     Res       Res       Seat          Main     Thanked   Advised
      #     locator    found   assignment      Result
              info
       1     valid     found     already         seat      yes
                                assigned      assigned
       2     valid     found   assignable        seat      yes
                                              assigned
       3     valid     found       not         request     yes      yes
                               assignable      queued
       4     valid      not                                yes      yes
                       found
       5     valid                                                  yes



     Source(s):


     Comment(s):




Template

     [post-modified verb]


     [Condition table(s)]


     Source(s):


     Comment(s):




                                - 16 -
Derived Tasks


Examples

     <without conditions>

     arrange trip

     Arrange transportation
     Arrange housing

     Source(s):


     Comment(s):



     <with conditions>

     arrange air travel

     If destination airport is not known
            Determine destination airport
     Endif
     Arrange flight

     Source(s):


     Comment(s):


Template

     [post-modified verb]


     [Task breakdown]


     Source(s):


     Comment(s):




                               - 17 -
Event Profiles


Example

     Identify potential customers

                  Question                                     Answer
     What?                                 Accurately identify potential customers for
       – event summary                     the new umbrella coverage policy
     Who, Whose or Which?                  System analyzes current and former AI
        – interactors or system            customer databases
        – entities
     With what?                            Data mining program
        – instrument of action
     Why?                                  The resulting potentials file will contain
        – goal or rationale                access keys for each current and former
        – post-conditions                  customer that satisfies the selection criteria.
        – next events                      Potentials will be notified about the new
                                           policy by e-mail, snail mail, and phone.
     When?                                 Program will run several times as the user is
        – preconditions                    expected to adjust the selection criteria.
        – constant conditions
        – triggers
        – frequency
     How many, how much, or how long?      Marketing manager estimates about 15% of
        – types, quantities, or duration   customers are eligible (750K of 5M).
     From and To whom or where?            Marketing manager will provide the
        – origin and destination           disposition of the potentials file by June 1st.
     How?
        – action steps or subtasks
        – variants

     Source: Guy Sales, AI marketing manager

     Comments:




                                    - 18 -
Template

  [event name]

                   Question               Answer
     What?
       – event summary
     Who, Whose or Which?
       – interactors or system
       – entities
     With what?
       – instrument of action
     Why?
       – goal or rationale
       – post-conditions
       – next events
     When?
       – preconditions
       – constant conditions
       – triggers
       – frequency
     How many, how much, or how long?
       – types, quantities, or duration
     From and To whom or where?
        – origin and destination
     How?
       – action steps or substeps
       – variants


     Source(s):


     Comment(s):




                              - 19 -

								
To top