topic Re: How to write Technical Spec in Application Development and Automation Discussions

How to write Technical Spec

Former Member — Thu, 22 Jun 2006 06:53:27 GMT

Hi all,

Give me some standards to write Technical specification.

Thanks for sending reply

Venkat

Re: How to write Technical Spec

former_member189629 — Thu, 22 Jun 2006 13:33:21 GMT

Hi Venkat

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

If you find it useful, please reward me for the same.

Good luck!

Karthik Potharaju

Re: How to write Technical Spec

Former Member — Thu, 22 Jun 2006 13:38:58 GMT

HI Venkat,

Plz check this.

1 Low Level Design

1.1 General Information

The system shall allow the manual as well as automatic creation of a pick order against a delivery. In the case of manual pick orders, the system shall require the user to specify a bin location. For automatic pick order generation, the system shall use the FIFO (First In First Out) method to select the bin number. The system shall allow for automatic pick quantity confirmation via customized RF scanner screen interface.

The system shall allow for automatic delivery update via customized RF scanner screen interface. The system shall update the delivery with picked serial numbers.

The system shall automatically perform a post goods issue (PGI) transaction after pick confirmation and delivery update.

The system shall allow the user to scan the pump serial numbers and perform pick confirmation before shipment to customer. After the confirmation system shall allow the user to perform the Post Goods Issue transaction.

1.2 Business Overview

The purpose of this custom RF transaction is to give the users a flexible tool that can be used to scan the serial numbers to confirm the pick and perform Post Goods Issue transaction for the pumps to ship to customer.

1.3 Development Description - Technical Details

1.3.1 Object Details

Object Name Transport Request# Development Class Message Class Description

1.3.2 Selection Screen Details

Screen 1

1.3.3 Program Logic:

1.3.4 Data Input Details

1.3.5 Database Tables Used

Table Name Description (only for the custom tables) Read (Y/N) Update (Y/N) Comments

1.3.6 External files used

N/A

1.4 Process Flow

N/A

1.4.1 Dependencies

1.4.2 Data Flow

N/A/

1.4.3 Security and Control Requirements

1.4.4 Trouble Shooting / Error Handling/Restart & Recovery

1.4.5 Batch Scheduling Requirements

1.4.6 Program Output

1.4.7 Other

N/A

1.5 References

1.5.1 Hospira HLD

N/A

1.5.2 Functional Contacts

1.5.3 Other Technical Contacts

Re: How to write Technical Spec

Former Member — Thu, 22 Jun 2006 13:43:56 GMT

hi,

In technical Spec you need to mention all the important details. i m providing some of it...

Specification Title

Author

Creation date

Program Name

Program Description

Development Class

Message Class

Program Type

Functional Area/Sub Area

Transaction code

Development Client

Testing Client

Reference program

Remedy id

Reference Business Design Doc

Reference Functional Spec

SAP Correction #

Processing Type

Frequency

Trigger

Volume

Complexity

Priority/Expected On or Before

Business Overview

Technical Specification

Program Selection.

Program Logic(This is the most important part)

Output

hope this will be useful

Regards,

Richa

Re: How to write Technical Spec

Former Member — Thu, 22 Jun 2006 13:54:14 GMT

Hi Venkat:

Here is another format for a tech spec. Its up to your implementation how detailed or you want to be , you may remove some sections or add your own.

Here is one for design of an interface:

1. Description 4

1.1 Project Overview 4

1.2 Document Purpose 4

1.3 Requirement Overview 4

1.5 External System Overview 5

2. Requirements 6

2.1 Functional Requirements 6

2.1 Data Exchange Requirements 10

2.2 Technical Requirements 11

3. SAP Transaction Overview 12

3.1 Create Notification – Transaction IW21 12

3.2 Update Notification – Transaction IW22 12

4. Operating System Files 12

5. Data Mapping – Inbound - Create Notification 15

5.1 Notification Types: N1 & N7 15

5.2 Notification Types: N2 21

5.3 Notification Type: N9 25

6. Data Mapping – Inbound - Update Notification 30

6.1 All Notification Types 30

7. Data Mapping – Outbound 31

7.1 Notifications 31

7.2 Work Order 31

8. Development Information 33

9. Development Checklist 35

10. Program Design - Inbound 36

11. Program Design - Outbound 40

12. Prerequisites and Dependencies 41

13. Interface Reporting 42

14. Idoc Error Correction 44

15. Frequency of Execution – Production Set-up 45

16. Assumptions 46

16. Issues 47

18 Acceptance 48

Re: How to write Technical Spec

Former Member — Thu, 22 Jun 2006 13:56:10 GMT

Another version I used on a smaller project for a program to create an automatic posting

1. Introduction 4

1.2 Document Purpose 4

2. Requirements 5

2.1 Functional Requirements 8

2.2 Design 8

3. SAP Transaction Overview 12

3.1 Create Invoice – FB01 12

4. Data Mapping – Vendor Invoice 15

4.1 Credit Balance in the tax Accounts 15

4.2 Debit - Balance in the tax accounts 15

5. Development Information 17

6. Program Design - Inbound 18

7. Prerequisites and Dependencies 18

8. Frequency of Execution – Production Set-up 18

9. Assumptions 19

10. Issues 19

18 Acceptance 21

Re: How to write Technical Spec

Former Member — Thu, 22 Jun 2006 14:01:40 GMT

Here is one for a report writer report

1. INTRODUCTION 3

2. INTENDED USER GROUP 3

4. REQUIREMENTS DEFINITION – NEW REPORT 4

4.1 Report Objects 4

4.2 Set Structure 4

5. EXECUTE REPORT 6

5.1 Step 1 – Enter Selection Criteria 6

5.2 Step 2 – Enter Summation Levels 7

5.3 Step 3 – Export Report 8

6. ROLES AND RESPONSIBILITIES 11

7. ASSUMPTIONS 11

And still another one fot an online java application ...

1. INTRODUCTION 1

1.1 PURPOSE OF THE DOCUMENT 1

1.2 DOCUMENT OVERVIEW 1

1.3 REFERENCES 1

1.4 OUTSTANDING ISSUES/ACTIONS 1

1.5 ASSUMPTIONS 2

1.6 ARCHITECTURAL DEVIATIONS 2

2. UNIT TASK DESCRIPTION 3

2.1 UNIT TASK DEFINITION 3

2.1.1 General Information 3

2.1.2 Summary Description 3

2.1.3 Input and Output Parameters 3

2.1.4 Volumetrics 3

2.2 UNIT TASK DYNAMICS 4

2.2.1 Sequence of the Unit Task Activities 4

3. USER INTERFACE COMPONENT 6

3.1 SCREEN ‘screen name' 6

3.1.1 Screen Overview 6

3.1.2 Screen Type 7

3.1.3 Field and Window Component Descriptions 7

3.1.4 Navigation 8

3.1.5 Controls 8

3.1.6 Window Tabs 9

4. DESCRIPTION OF OPERATIONS 12

4.1 OPERATION 2.1.1.1 CREATE ... 14

4.2 OPERATION 2.1.1.2 UPDATE .. 14

4.3 OPERATION 2.1.1.3 CHECK USER SECURITY.. 15

4.4 OPERATION 2.1.1.4 INVOKE .... 15

4.5 OPERATION 2.1.1.5 ADD .... 15

4.6 OPERATION 2.1.1.6 DEACTIVATE .. 16

4.7 OPERATION 2.1.1.7 MAINTAIN ... 24

5. SECURITY 26

APPENDICES

A. DESIGN NOTES

List of Figures

Figure 3 1 ..

hope this helps BAR

Re: How to write Technical Spec

Former Member — Thu, 22 Jun 2006 14:17:01 GMT

GOOD

GO THROUGH THE FOLLOWING LINKS

http://www.sdn.sap.com/irj/servlet/prt/portal/prtroot/com.sap.km.cm.docs/library/icc/nw-vsi interface documentation.pdf

THANKS

MRUTYUN