How do we write technical specs?

[Former Member]

How do we write technical specs?

[Former Member]

Hi,

The points to be included in technical specs are:

Business Requirement

From business standpoint describe:

Objective - What the object(s) are supposed to accomplish?

Purpose - Describe what are the purposes of these object(s)?

Users - Describe who will use are these object(s)? And when? And where?

Known Errors / Issues - Describe any known errors and issues

Provide Business Process and data flow diagram

3.0 Detail Level Design

3.1 Design Approach

Provide technical design approach along with alternatives and driver that led to choosing a particular approach

3.2 Detailed Design

3.1.1 Technical Configuration Requirements

What configuration is required to support this process? Does this process require master data to be loaded? Specify any application configuration settings, custom table entries, etc.

3.1.2 Object List

Give a list of the component/objects that need be created / modified.

No. Object Name Object Type Description

1.

2.

3.

3.1.3 Object Relationships

Provide pictorial representation of technical design and link it to the list of objects defined above.

u2022 Object relationship diagram

u2022 Data flow diagram

u2022 Screen navigation diagram

u2022 Use-case diagram

4.0 Object details

Provide detail for each object defined in 3.1.2

4.1 Object Name 1

4.1.1 Attributes

4.1.2 List each tables and File Structure

<Enter name(s) of the table(s) be used in the program>

Object Name

Field Short Text Data Element

/ Field Type Field Length Additional info

4.1.3 Function / Methods / processing logic

<Enter name of the functional module used in the programs>

<Indicate status keys and name of the function to be indicated for screens used in the module pool programs, if any>

4.1.4 Interfaces / BDC mappings

Non-EDI Interfaces / Data Mapping

<For BDC, Run SHDB Transaction and give Session name. >

<Embed Data Mapping Sheet here>

<Third party tools such as IM/3>

EDI Interfaces

<Message type, Partner profile details>

4.1.5 Technical configuration / Settings (Including printer settings)

<Enter settings details >

4.1.6 Events

4.1.7 Screen

Parameter / Select options (selection-screen)

Screen Name

TYPE Field Field description Table Mandatory / Non-mandatory Match Code required (Y / N)

u2022 Field Validations

u2022 Radio Groups

u2022 Check Boxes

Push Buttons for Drilldown reports on different levels

Button Field name Drilldown from Drilldown To

Screen Layout (In case of Transactions)

<Enclose the same if applicable and indicate to refer attached sheet>

Navigation Diagram (or Screen flow)

<Provide screen navigation diagram>

4.1.8 Layout and Presentation

4.1.9 Sort Options

4.1.10 <Enter your contents here>

Report or file Layout (In case of Reports)

<Enclose the same if applicable and indicate to refer attached sheet>

< Provide additional information on expectation e.g. Download options>

4.1.11 SAP Script Layout (In case of SAP Scripts)

<Enclose the same if applicable and indicate to refer attached sheet>

Logo for SAPScript in case of non-pre-printed stationary

<Attach TIF file in Version 6.0 & above>

Printing of SAPScript

<Enter printer details, Attach hardcopy of pre-printed Stationary. >

< Provide additional information on expectation e.g. Font type, size etc.>

4.1.12 Special Requirements

<Enter your contents here, if applicable>

4.1.13 Authorization Check

<Enter authorization checks to be incorporated, if required>

4.1.14 Error Control and Handling

What errors may occur and how they should be treated.

Message Reference Number Type

[I,E,W] Stop Program (Yes/No)

Message Text Message Display [Selection screen, Popup, etc.] Conditions Where the Message Should Occur

999 E Yes { e.g. Account group excluded } End of report { e.g. If the group is excluded }

4.1.15 Authorization Groups / Authorization Objects

Please refer to the functional specification for the appropriate security levels.

ABAP Considerations: Do any of the programs need special authorization groups, if so, explain?

Do the users need special security profiles to execute the enhancement, if so, explain?

{e.g. The transaction program will verify that the user has the correct authority on transaction entry. }

4.1.16 Internationalization / Localization

<Enter approach for language translation, currency conversion and compliance to legal requirement here>

5.0 Test data and Conditions

Determine how to validate the Object. (e.g. how do you make sure that the Report was run and has worked correctly?) List any transactional data that will be used to validate the report both in a production state and for testing purposes (i.e. specific types of sales transactional data, adjustments, etc)

<Enter test related data and testing conditions>

<Enter Menu path for Transaction ><Enter details of Test Data / Test cases for program & users. >

6.0 Implementation considerations

6.1 Dependencies

If the object has dependencies on the output of another enhancement, interface, background process, month end close, etc.

6.2 Transitional considerations

{ e.g. If change is being implemented in phased manner, provide the impact of phased implementation on lifecycle and logic of the objects and related configuration and data elements }

6.3 Related Documents

{ e.g. Give the reference or embed of all the documents related to the object }

7.0 Basic assumptions (Notes) and limitations (constraints) of the system

<Include here a description of the architectural constraints, and design assumptions from the perspective of requirements, development, testability and maintainability. >

No. Description Comments / References

1.

2.

3.

8.0 Open Issues

<Enter comments/issues or Concerns that donu2019t logically fit in one of the other sections of the specification document. >

Issue No. Description Comments / References

1.

2.

3.

[Former Member]

Hi,

TS template are client specific.

Ask any seniour person from ur project to provide template used for TS .

In that TS u have to provide details such as developer, tester, std tables used, Internal tables, Process flow etc.

Reward pts if useful.

Regards,

Dhan