Tek-Tips is the largest IT community on the Internet today!
Members share and learn making Tek-Tips Forums the best source of peer-reviewed technical information on the Internet!
-
Congratulations SkipVought on being selected by the Tek-Tips community for having the most helpful posts in the forums last week. Way to Go!
Sample Project Spec
- Thread starter Beesknees
- Start date
ponderworks
IS-IT--Management
Hi,
In many respects you are in a unique position to write this specification. I did a quick search and did not see anything immediately available out on the web, but, you might be able to find something given more time.
Meanwhile:
In theory, a business analyst or someone familiar with the business need for the system should have written functional specifications. If so, read them over carefully and consider the following. Depending on what you are creating, NOT all of the following will apply. If there isn't one, you should create one, even a high level one would be acceptable if the overall system is small or limited in the size of user community. Make sure you get sign off of the functional specs from the customer and that the spec is detailed enough so that they can't dispute what you delivered when it is done. If you have any doubt in your discussions with the customer, just add more wording, sample screens, or whatever else it takes to make it clear.
- The technical spec should show how the functional specifications will be delivered in the final, coded system.
- Based on the functional spec, create a checklist of documented functions and then add undocumented functions needed to create the documented ones. Go over the list a few times to be sure you have captured all the functionality the finished system will need. Have someone else check it. Use this list to check off as you complete the technical spec for each function.
- A programmer, DB designer, UI developer, etc. should be able to take your technical spec and use it as a guide to actually build the system.
- include detailed descriptions, mockups, screen validation requirements, etc for all user interface elements. Include navigational descriptions for how a user goes from one place to another (especially important for web apps).
- include stated performance requirements from the functional spec and how those are being addressed in code and design.
- include mockups of all output (ie. reports, displays, etc)
- include full specifications for database tables, fields, stored procedures, physical design, scripts, batch processing, error handling, external system interactions (related system calls, dependent system feeds)
- You should be working closely with whomever writes and executes the test plans.
- arrange to have someone else read the functional spec then the technical spec and offer input on whether the requirements have been captured.
If this seems a bit involved, it is. However, if you have a signed off functional spec and the technical spec is written in stages, you can jump start the development process by having technical staff begin creating the functionality for which technical specs are completed. Ideally, the person who wrote the functional spec can sign off on the technical spec certifying that the tech spec is an accurate "implementation" of the functional spec.
Hope this helps get you started. The whole process is designed to make sure you head down this development road only once!
Good luck!
In many respects you are in a unique position to write this specification. I did a quick search and did not see anything immediately available out on the web, but, you might be able to find something given more time.
Meanwhile:
In theory, a business analyst or someone familiar with the business need for the system should have written functional specifications. If so, read them over carefully and consider the following. Depending on what you are creating, NOT all of the following will apply. If there isn't one, you should create one, even a high level one would be acceptable if the overall system is small or limited in the size of user community. Make sure you get sign off of the functional specs from the customer and that the spec is detailed enough so that they can't dispute what you delivered when it is done. If you have any doubt in your discussions with the customer, just add more wording, sample screens, or whatever else it takes to make it clear.
- The technical spec should show how the functional specifications will be delivered in the final, coded system.
- Based on the functional spec, create a checklist of documented functions and then add undocumented functions needed to create the documented ones. Go over the list a few times to be sure you have captured all the functionality the finished system will need. Have someone else check it. Use this list to check off as you complete the technical spec for each function.
- A programmer, DB designer, UI developer, etc. should be able to take your technical spec and use it as a guide to actually build the system.
- include detailed descriptions, mockups, screen validation requirements, etc for all user interface elements. Include navigational descriptions for how a user goes from one place to another (especially important for web apps).
- include stated performance requirements from the functional spec and how those are being addressed in code and design.
- include mockups of all output (ie. reports, displays, etc)
- include full specifications for database tables, fields, stored procedures, physical design, scripts, batch processing, error handling, external system interactions (related system calls, dependent system feeds)
- You should be working closely with whomever writes and executes the test plans.
- arrange to have someone else read the functional spec then the technical spec and offer input on whether the requirements have been captured.
If this seems a bit involved, it is. However, if you have a signed off functional spec and the technical spec is written in stages, you can jump start the development process by having technical staff begin creating the functionality for which technical specs are completed. Ideally, the person who wrote the functional spec can sign off on the technical spec certifying that the tech spec is an accurate "implementation" of the functional spec.
Hope this helps get you started. The whole process is designed to make sure you head down this development road only once!
Good luck!
- Status
Similar threads
