Guidelines on writing Software specification - Revision history

Admin at 12:04, 11 May 2011

2011-05-11T12:04:59Z

Admin at 08:37, 2 December 2010

2010-12-02T08:37:34Z

Admin: /* Example 1. vBulletin integration */

2010-04-08T10:43:30Z

‎Example 1. vBulletin integration

Admin at 10:42, 8 April 2010

2010-04-08T10:42:38Z

Admin: /* Specification template */

2010-04-08T10:38:02Z

‎Specification template

Admin: /* Specification template */

2010-04-08T10:37:31Z

‎Specification template

Admin: /* Specification template */

2010-04-08T10:36:59Z

‎Specification template

Admin at 10:32, 8 April 2010

2010-04-08T10:32:55Z

Admin at 10:27, 8 April 2010

2010-04-08T10:27:06Z

Vladimir.gritsenko at 10:58, 7 April 2010

2010-04-07T10:58:12Z

← Older revision		Revision as of 12:04, 11 May 2011
Line 204:		Line 204:
	* [http://en.wikipedia.org/wiki/Software_Requirements_Specification SRS on Wikipedia]		* [http://en.wikipedia.org/wiki/Software_Requirements_Specification SRS on Wikipedia]
	* [[Qualiteam professional services FAQ]]		* [[Qualiteam professional services FAQ]]
		+
		+	[[Category:Qualiteam services]]

← Older revision		Revision as of 08:37, 2 December 2010
Line 203:		Line 203:

	* [http://en.wikipedia.org/wiki/Software_Requirements_Specification SRS on Wikipedia]		* [http://en.wikipedia.org/wiki/Software_Requirements_Specification SRS on Wikipedia]
		+	* [[Qualiteam professional services FAQ]]

@@ Line 118: / Line 118: @@
 Roles:
+* Registered user
-- Registered user
+* Visitor
 '''USE CASE "User registration"'''

@@ Line 99: / Line 99: @@
 </div>
-==Specification examples==
+==Example 1. vBulletin integration==
-<pre>
+<div style="border:solid 1px #A8A8A8; padding:0.5em 1em 0.5em 0.7em;  margin:0.5em 0em; font-size:85%; background-color:#F0F0F0">
+'''1. Project summary'''
 Main scope of the project is to integrate X-Cart with vBulletin forum. Registration, profile updates and login functions should be merged.
-. Terms and Definitions
+'''2. Terms and Definitions'''
 There are no new terms and definitions.
-. Environment
+'''3. Environment'''
 New X-Cart v4.3.1. Not installed yet.
-. Functional requirements
+'''4. Functional requirements'''
 Roles:
@@ Line 125: / Line 123: @@
 - Visitor
-USE CASE "User registration"
+'''USE CASE "User registration"'''
 If a visitor registers in vBulletin, the system must create an account in X-Cart and fill it with the submitted data automatically. And vice versa, if a visitor registers
@@ Line 133: / Line 131: @@
 If a field in one system does not have analogue in another, it will not be copied.
-USE CASE "Personal information update"
+'''USE CASE "Personal information update"'''
 If a registered user updates the profile in vBulletin, his/her X-Cart profile must be updated as well. Same with X-Cart to vBulletin direction.
@@ Line 139: / Line 137: @@
 If a field in one system does not have analogue in another, it will not be updated.
-USE CASE "User logging in/out"
+'''USE CASE "User logging in/out"'''
 Regardless of where a registered user submits his/her username and password, he/she must be logged both in vBulleting and X-Cart.
@@ Line 145: / Line 143: @@
 Regardless of where a registered and logged in user logs out, he/she is logged out in another system simultaneously.
-. Other requirements (non-functional and system)
+'''5. Other requirements (non-functional and system)'''
 Changes must not slow down the entire system considerably.
-. Resources
+'''6. Resources'''
 http://www.vbulletin.com/
-</pre>
+</div>
-. Self-registry facility for providers
+==Example 2. Self-registry facility for providers==
-<pre>
+<div style="border:solid 1px #A8A8A8; padding:0.5em 1em 0.5em 0.7em;  margin:0.5em 0em; font-size:85%; background-color:#F0F0F0">
+'''1. Project summary'''
 By default providers cannot register with X-Cart Pro. An administrator has to do it instead. The scope of the project is to add such an ability. All the info
@@ Line 165: / Line 162: @@
 should be submitted by a provider and the admin will just activate the account.
-. Terms and Definitions
+'''2. Terms and Definitions'''
 n/a
-. Environment
+'''3. Environment'''
 X-Cart Pro v4.1.8 installed at http://www.yoursite.com/store/
-. Functional requirements
+'''4. Functional requirements'''
 Roles:
-- admin
+'''USE CASE "New provider registration"'''
 There must be a new registration form similar to the one for the customers allowed at http://www.yoursite.com/store/provider/register.php
@@ Line 187: / Line 183: @@
 Any visitor must have an ability to submit this new form. However the newly created account must be suspended until the admin approves it.
-USE CASE "Approval of new provider accounts"
+'''USE CASE "Approval of new provider accounts"'''
 There must be a "Status" drop-down box at the provider profile modify page in the admin area. There must be two options: "Not active" (default) and "Active".
@@ Line 193: / Line 189: @@
 The admin must be able to change this property.
-USE CASE "Provider log in"
+'''USE CASE "Provider log in"'''
 If a provider logs in, the system must check whether his/her profile is active or not. If it is not, an error message should appear instead of letting the person in.
-. Other requirements (non-functional and system)
+'''5. Other requirements (non-functional and system)'''
 n/a
-. Resources
+'''6. Resources'''
 n/a
-</pre>
+</div>
 ==See also==
 * [http://en.wikipedia.org/wiki/Software_Requirements_Specification SRS on Wikipedia]

@@ Line 47: / Line 47: @@
 ==Specification template==
-<div style="border:solid 1px #A8A8A8; padding:0.5em 1em 0.5em 0.7em;  margin:0.5em 0em; font-size:85%; background-color:#FCFCFC">
+<div style="border:solid 1px #A8A8A8; padding:0.5em 1em 0.5em 0.7em;  margin:0.5em 0em; font-size:85%; background-color:#F0F0F0">
 '''1. Project summary'''

@@ Line 47: / Line 47: @@
 ==Specification template==
-<pre>
+<div style="font-color:#535068; border:solid 1px #A8A8A8; padding:0.5em 1em 0.5em 0.7em;  margin:0.5em 0em; font-size:85%;">
-. Project summary
+'''1. Project summary'''
 This point includes the project overview, the scope and the purpose. It should present a brief list of the new functions and the necessary changes.
-. Terms and Definitions
+'''2. Terms and Definitions'''
 Optional point that describes all the new terms used in the specification and redefines the already known ones.
-. Environment
+'''3. Environment'''
 Title and version of the software product to be modified (e.g. X-Cart Pro v4.3.1) and the direct URL to the software,
@@ Line 62: / Line 62: @@
 if it is already installed (e.g. http://www.mysuperstore.com/xcart/).
-. Functional requirements
+'''4. Functional requirements'''
 Roles:
-- Store owner
+'''USE CASE "[Title of first usecase]"'''
 [Description of first usecase]
-USE CASE "[Title of second usecase]"
+'''USE CASE "[Title of second usecase]"'''
 [Description of second usecase]
-USE CASE "[Title of third usecase]"
+'''USE CASE "[Title of third usecase]"'''
 [Description of third usecase]
@@ Line 86: / Line 85: @@
 ...
-USE CASE "[Title of N-th usecase]"
+'''USE CASE "[Title of N-th usecase]"'''
 [Description of N-th usecase]
 . Other requirements (non-functional and system)
 This point includes requirements which impose constraints on the design or implementation (such as performance engineering requirements, quality standards, or design constraints).
-. Resources
+'''6. Resources'''
 Examples, links to documentation reference, sketches &etc go here.
-</pre>
+</div>
 ==Specification examples==

@@ Line 18: / Line 18: @@
 '''Specific Functional Requirements'''
-* Are all the inputs to the system specified, including their source, accuracy, range of values, and frequency?
+* Are all the inputs to the system specified, including their source, range of values and format?
-* Are all the outputs from the system specified, including their destination, accuracy, range of values, frequency, and format?
+* Are all the outputs from the system specified, including their destination, range of values and format?
 * Are all output formats specified for web pages, reports, and so on?
 * Are all the tasks the user wants to perform specified?
 * Is the data used in each task and the data resulting from each task specified?
@@ Line 45: / Line 43: @@
 * Where information isn't available before development begins, are the areas of incompleteness specified?
 * Are the requirements complete in the sense that if the product satisfies every requirement, it will be acceptable?
-* Are you comfortable with all the requirements? Have you eliminated requirements that are impossible to implement and included just to appease your customer or your boss?
+* Are you comfortable with all the requirements? Have you eliminated requirements that are impossible to implement?
 ==Specification template==
@@ Line 60: / Line 58: @@
 . Environment
 Title and version of the software product to be modified (e.g. X-Cart Pro v4.3.1) and the direct URL to the software,
 if it is already installed (e.g. http://www.mysuperstore.com/xcart/).
@@ Line 129: / Line 127: @@
 USE CASE "User registration"
 If a visitor registers in vBulletin, the system must create an account in X-Cart and fill it with the submitted data automatically. And vice versa, if a visitor registers
 in X-Cart, the system must automatically create a vBulleting account for him/her.
@@ Line 163: / Line 161: @@
 . Project summary
 By default providers cannot register with X-Cart Pro. An administrator has to do it instead. The scope of the project is to add such an ability. All the info
 should be submitted by a provider and the admin will just activate the account.