Documentation of ABAP Developments
Target Audience
This chapter is aimed at ABAP developers, software architects, technical writers and development managers and is based on the content of the DSAG recommended action Best Practice Guide Development - practical tips on the topic of ABAP Development”. The chapter has been modernized and expanded to include content where appropriate.
We aim to support you with the chapter’s content in implementing and optimizing your technical documentation tasks for ABAP development and, where possible, offer you practical solutions that will help you and your colleagues in the long term with knowledge transfer regarding your custom software.
Contents of This Chapter
Technical documentation serves to convey knowledge and is intended to provide readers with a quick introduction to the architecture and functionality of a software system without requiring them to delve into the details of the system at the source code level. If documentation is missing or insufficient, this leads to increased effort, at the latest when the system is further developed or when developers change.
In general, it is important with any documentation to strike the right balance and avoid the two extremes of documentation that is too extensive and often outdated, or no documentation at all. This can be remedied by defining clear, easy-to-understand documentation guidelines enriched with examples. If the official requirements for documentation are too high or too abstract, this usually results in the documentation either not being created at all or being of poor quality.
Documentation should be created during development, but absolutely must be completed before the system goes live or is deployed, and the system should not go live without the documentation being finished. Otherwise, this usually results in additional work or, ultimately, missing documentation.
Are you interested in how artificial intelligence can support your documentation projects? Then just take a look at the following chapter: