neos team mailing list archive
-
neos team
-
Mailing list archive
-
Message #00653
[Blueprint docu-specification-blueprint-guideline] (DOCU) Guideline for specification-blueprints
Blueprint changed by Johannes Wettinger:
Whiteboard changed:
1. REQUIREMENTS & SPECIFICATION
- {short description of the requirements and the specification of the
- feature itself}
+ ... Description of the requirements and the specification of the feature
+ itself ...
----
- 2. USE CASES
+ 2. DESIGN & TECHNICAL SOLUTION
- 2.1. {SHORT SUMMARY OF THE USE CASE IN CAPITAL LETTERS}
-
- [ACTORS]
- {one or more roles, e.g. 'Scribe' or 'Moderator, Scribe'}
-
- [PRECONDITION]
- {short description of the precondition for this use case}
-
- [NORMAL FLOW OF EVENTS]
- (1) {short description of the first event}
- (2) {short description of the second event}
- (3) {short description of the third event}
- {...}
-
- [POSTCONDITION]
- {short description of the postcondition for this use case}
-
- [ALTERNATIVE FLOWS OF EVENTS]
- {description of alternative flows of events for this use case; you should reference the steps of the normal flow of events}
-
- --
-
- 2.2. {SHORT SUMMARY OF THE NEXT USE CASE IN CAPITAL LETTERS, IF THERE IS
- ONE}
-
- {...}
+ ... Description of the design and the technical solution
+ (implementation) ...
----
- 3. DESIGN & TECHNICAL SOLUTION
+ 3. UNIT TESTING
- {short description of the design and the technical solution /
- implementation}
-
- ----
-
- 4. UNIT TESTING
-
- {if the feature is part of the user interface only, just write 'For this
- feature there is no unit testing because it is part of the user
+ ... If the feature is part of the user interface only, just write 'For
+ this feature there is no unit testing because it is part of the user
interface only.'; otherwise give a short overview which unit tests have
- to be implemented}
-
- ----
-
- 5. SYSTEM TEST
-
- This feature is tested by running each of the Use Cases defined above.
- The results of the execution(s) of this test will be recorded here.
-
- 5.1. TEST PROTOCOL {date on which the test was done; format YYYY-MM-DD}
-
- [USE CASE 2.1]
- {short comment like 'Ok, no errors (normal flow of events)' or 'Error occured after continuing with step 5, the problem is ...'}
-
- [USE CASE 2.2]
- {short comment}
-
- {...}
-
- --
-
- 5.1. TEST PROTOCOL {date on which the test was done; format YYYY-MM-DD}
-
- {...}
+ to be implemented ...
--
(DOCU) Guideline for specification-blueprints
https://blueprints.launchpad.net/revager/+spec/docu-specification-blueprint-guideline