Changeset 10699 for main/eko-disco-specs

Timestamp:

5 Nov 2013, 12:13:27 (11 years ago)

Author:

uli

Message:

Update data section: how to describe data entities.

Location:

main/eko-disco-specs/trunk

Files:

• data.rst (modified) (1 diff)
• use-cases.rst (modified) (1 diff)

main/eko-disco-specs/trunk/data.rst

@@ +1 @@
+.. _label-data-entities:
+
 Data Entities
 =============
 
-* Contracts
+These are the data entities the new system is supposed to model. Each
+of these entities should be addable, editable, and removable as
+covered in more detail in :ref:`label-use-cases`.
+
+For each entity we give a short description to tell what it means,
+what its purpose is and in what regards (and how) it should be handled
+by the system. Again the more detailed actions on these entities
+provided by the system are described in the :ref:`label-use-cases`
+section.
+
+The data entities are sorted alphabetically, not by importance or
+similar. Used description terms should link to other respective
+entities/terms where possible.
+
+.. _label-account:
+
+* Account
+    A customer account contains the assets/debts of a :ref:`customer
+    <label-customer>`. It is *not* a system account (see :ref:`Login
+    Credentials <label-login-credentials>` for that) but a virtual
+    financial account kept by the system. Basically it tells, how much
+    money a certain :ref:`customer <label-customer>` owes or is
+    eligible for. Each customer has exactly one account in the system.
+
+.. _label-contact-data:
+
+* Contact Data
+
+
+.. _label-contract:
+
+* Contract
+
+.. _label-contract-types:
 
 * Contract Types
 
+.. _label-contract-termination:
+
 * Contract Termination
+
+.. _label-consumption:
 
 * Consumption
 
-* Contractor
+.. _label-customer:
+
+* Customer
     beneficiary of a contract
+
+.. _label-login-credentials:
+
+* Login Credentials
+
+.. _label-meter:
 
 * Meter
 
+.. _label-meter-status:
+
 * Meter Status
 
-* Timestamp
+.. _label-meter-value:
 
 * Meter Value
 
-* Meter-Reader
+.. _label-meter-reader:
 
-* Contact Data
+* Meter Reader
 
-* Payments
+.. _label-payment:
 
-* Account
+* Payment
 
-* Login Credentials
+.. _label-report:
 
-* Reports
+* Report
+
+.. _label-timestamp:
+
+* Timestamp

main/eko-disco-specs/trunk/use-cases.rst

@@ +1 @@
+.. _label-use-cases:
+
 Use Cases
 *********