Cursory Review: Technical Spec Outline
-
If someone has a spare minute or two, please could you give me some critique on my draft outline for a technical spec for an ASP.NET web site. Have I left out any important high level sections? 1. Overview 1.1. Description of goal of the project. 2. Use Cases. 3. Business Objects. 3.1. Business Object Name and description. E.g. ‘User Comment’ 3.1.1. Business Object Attributes. E.g. 3.1.1.1. Comment Date 3.1.1.2. Staff Member 4. Business Rules. 5. General Architecture. 5.1. Data Tier. 5.1.1. Platform and implementation. 5.2. Business Tier. 5.2.1. Platform and implementation. 5.3. Presentation Tier. 5.3.1. Platform and implementation. 6. Database 6.1. Security. 6.2. Conventions. 6.2.1. Naming. 6.2.2. Table Keys. 6.2.3. Tactics, e.g. only using stored procedures for access, only using views for reporting, etc. 6.3. Tables. 6.3.1. MS Word Table of table names and contents. 6.4. Stored Procedures 6.4.1. MS Word Table of stored procedure names, purposes, and tables accessed. 7. User Interface 7.1. Overview 7.1.1. ASP.NET 7.1.2. AJAX. 7.1.3. Master Pages. 7.1.4. Use of Page and User Controls. 7.1.5. Detailed Descriptions of all pages and controls. 7.2. Layout. 7.2.1. Design. 7.3. Graphics. 7.3.1. Images and animated content. 7.3.2. General Theme. 8. Miscellaneous. 8.1. Deployment. 8.2. Configuration. 8.3. Administration.