ADT: Documenting ABAP Development Objects

[michael_gutfleisch]

Hi ADT Community,

the ABAP Repository supports far more than 100 object types. Many of them provide also documentation capabilities, mainly based on SAP Script. Classes and Interfaces can also be documented with ABAP Doc.

Especially with RAP, a bunch of new object types  have been invented. And of course we also need documentation for these new object types. Sio we decided to introduce so called Knowledge Transfer Documents (KTD) and connected the to the new object types like CDS Views, Behavior Definitions, Service Definitions and more.

Within ABAP Develoment Tools (aka ADT or ABAP in Eclipse) we provide a brand new editor which you can use to create and edit the new kind of documentation.

Below you find three informative and entertaining videos with almost everything you might want to know about the new documentation concept and the tool support in ADT.

 

The first video introduces the basic concepts of KTD and is perfect for you to get in touch with the new concept and the tool support. After watching you can already get you hands dirty and start creating your first Knowledge Transfer Documents.



 

The second video gives you information about advanced features like linking to other objects and integration into element info.



 

Finally, the third video explains how you can find development objects based on their documentation status, so that you can easily find objects without documentation or review and rework existing documentation. This is not only about KTD, but also about SAP Script documentation.



 

Now you should really be an expert in the area of "Documentation of ABAP Development Objects". You know how to use the tools and understand the concept behind. I hope you enjoy working with Knowledge Transfer Documents.

If you have any questions or ideas for improvement please let us know, by commenting this blog post.

 

Regards,
Michael

[Vladimir_Kosovt]

This is not1 but 20 minutes with all the videos, but I liked your videos!

Very stylish and pretty

[rienahs]

I like this short tutorial very much! A brief overview about this new technique.

The following questions remain unanswered from my point of view:

1. How to make it work with german umlauts?


2. Is there a proposed naming convention for the KTD? Some basic objects can have the same name, so a differentiation for the KTD may be needed.


3. How these documents can be translated to another language?

Thank you very much!

[former_member260507]

Thanks for your post.

I only see the "New Knowledge Transfer Document" on the packages in my ADT.

Is there some setup to make them available on other objects (classes, cds,...)

or is there a required version of sap components & ADT ?

 

[michael_gutfleisch]

You don't need any additional setup. But as the video explains, KTD is not available for classes and interfaces but for new object types like CDS Views, Behavior Definitions, ...

[Sschlegel]

Hi Jörg,

Since round about one year, KTD should now support Umlauts etc. (aka UTF-8-Support)  😉
...there has been an issue how SAP set up their ADT internally and how it is shipped

Regards
Sören

[sh4il3sh]

I wanted to save the video to a playlist but YouTube won't let me because it's a part of YouTube Kids, if possible could you change that?

[KeldGregersen]

Does anyone have some good examples how to document fx. CDS views