Technical Documentation

[Former Member]

does anyone have sample documentation for an Abaper to document the coding or any specification they had modified?

i don't know whether this is the right place to post this thread but if i post wrongly, Moderator please move to the right forum... thanks moderator...

[Former Member]

hi,

go to se38 give the program name......and in the radio buttons options below choose the documentation one and then click create you will see the interface to create documentation for your program with a ready made template.

[Former Member]

there's blank page when i hit display... is it i have to hit the 'Edit Documentation' button?

[Former Member]

ya....press the change button

[Former Member]

thanks for your information but that's too simple... i need to make a hardcopy documentation as reference if there's a new developer need to refer to the coding and the changes that had been made for them to understand the overall company systems flow...

[Former Member]

Hi,

For that you need to prepare a Technical Specification for given Functional Specification. Functional Specification will provide the fuctional people for development to technical people. As on when devloper get that Functional Specification, developer will go through the FS and developer create the technical Specification. If any one comes new the people can refer rhe technical specification.

[Former Member]

thanksfor your reply... ya i understand what you try to explain but since i'm a fresh ABAPer, is there any source i could refer to it?

thanks once again...

[Former Member]

Hi

Please follow the Steps to be defined below for the Template. It is easy one I am explaing.

1. General Information

1.1 Scope of the Document- Please explain your requirements in this column

1.2 Constraint - if you have anything explain

1.3 Testing - Here you will provide some screen shots

2. Explain Technical Description

2.1 Explain Process

2.2 Provide your input Loic

2.3 retrieval Logic

2.4 Processing Logic

2.5 Display Output.

[MarcinPciak]

Yup, create technical documentation in MS word following the template your company uses or customer prefers.

Add information about all objects you developed (FMs, classes, DDIC objects, modules, includes etc). Provide all technical details regarding certain process. I.e Updating some custom table to hold certain information which other module uses for particular purpose (but don't comment you application "line by line"). Give also naming convetion used in applicaiton.

When creating such documentation always try to put yourself on someone's position, who will later be reviewing it to find for specific information. Is my information clear? Did I place everything what is necessary to change this process? Asking such qeustion yourself will bring you the instructions what is else outstanding. That's the easiest way to follow I think:)

Regards

Marcin