2008 Feb 20 4:35 AM
hi gurus,
what are the steps to take for writing technical spec's.
regards,
praveen
hi gurus,
what are the steps to take for writing technical spec's.
regards,
praveen
2008 Feb 20 5:11 AM
every project/company has its own Template for FS, TS etc...
Take the TS template, u can see many contents in that.
FS in the Functionality of the requirement.
TS is the Technical solution for that requirement.
u need to write the Pseudocode in the TS, how can you implement the technical solution for the requirement into its corr. content or paragraph.
generally any TS consists of the foll: as its content:
(this is an example for a report)
1. DETAIL DESIGN SPECIFICATIONS OVERVIEW
a. BUSINESS FUNCTIONALITY
b .MAJOR FEATURES
USER PROCEDURES
CHECK LISTS
ASSUMPTIONS:
CONSTRAINTS:
SECURITY CONSIDERATIONS
OBJECTS:
LTS SECURITY REQUIREMENTS:
RESTART/RECOVERY STRATEGY
PERFORMANCE CONSIDERATIONS
PROGRAM & DATA FLOW INTERACTION
PICTORIAL VIEW
INPUT DATA
COMMENTS
2. DETAILED PROGRAM DESIGN SPECIFICATIONS
PROGRAM DESCRIPTION
EXECUTION METHOD
PROGRAM TYPE
COMMON SUBROUTINES
EXCEPTIONS TO PROGRAMMING STANDARDS
LIST OF OBJECTS IMPACTED
INPUTS / OUTPUTS
ERROR MESSAGES AND CLASSES
BDC SESSIONS
STRUCTURES
DETAILED LOGIC
3. DETAILED REPORT DESIGN SPECIFICATIONS
(REPORT PROGRAM NAME)
REPORT DESCRIPTION
REPORT INVOCATION METHOD
REPORT APPLICATION
REPORT TYPE
REPORT CLASSIFICATION
REPORT MEDIUM
REPORT FREQUENCY
REPORT REQUEST METHOD
REPORT TIMING
REPORT ORIGINATOR
REPORT RECIPIENTS
REPORT PROCESSING ENVIRONMENT
REPORT LAYOUT
REPORT LAYOUT DESCRIPTION
REPORT SORT INFORMATION
REPORT CONTROL BREAKS
REPORT PAGE BREAKS
REPORT SUMMARY STATISTICS
REPORT MESSAGES
REPORT NUMBER OF PAGES / LINES / COPIES
REPORT PRINTING INFORMATION
Check this thread..It may be useful.
Regards.
2008 Feb 20 5:24 AM
Every organization may have diff template , you may require to follow the template . In TS you have to write clearly in technical term but dont do any copy pase from the code , which not at all sound good.
Find the below steps.
1.In 1st page you may require to give heading and company logo also at the RHS.
2.Give title of the document , SAP Module Name, Specification Type (Giv ein a tabular format)
3.Revision History in Tabluar Format including Author , Description , Date , Version ( Version management very imp try to maintain it)
4.Requirement Description : Enter in detail wat is u r reqmt.
5.U may add Process flow diagram using visio etc.
6.Outstanding issues
7.Prerequisites
8.Input Parameter Details
9.Processign logic Details
10.Out Put Details (if Report Output Format)
11.The few unit testing scripts also u can include
12.Proper file name , in header & Footer
13. Always try to keep track changes on for version management. If u need to create new version try to accept previous version then keep track for curren tchanges.
14. Maintain index & Page no in table content .
Eg..
Below are the standards for Tech specs
1.1 Development Attributes
Program Name:
Title:
Application:
Development Class:
Message Class:
Program Type:
Execution Mode:
Schedule Frequency:
Variant:
1.2 Program Functionality
1.3 Output Fields
Output Label
Related SAP table-field (if any)
Length
Output Characteristics
1.4 Proposed Solutions
1.5 Solution to be implemented
1.6 Reasons of selection/rejection
1.7 Pseudo-Code / Flow Logic of the selected solution
1.8 Selection Screen
1.9 Database Tables Used
Table Name
Table Description
How the table is used in the program
1.10 External Files Used
1.10.1 External File Layout <file name>
1.11 Components External to Program Used
1.12 Error Conditions
1.13 Key Technical Test Conditions
1.14 Sample Test Data
1.15 Assumptions
1.16 Comments
2008 Feb 20 5:26 AM
| User | Count |
|---|---|
| 3 | |
| 2 | |
| 2 | |
| 1 | |
| 1 | |
| 1 | |
| 1 | |
| 1 | |
| 1 | |
| 1 |