System documentation is needed to make information accessible to different target groups and can contain additional work instructions, especially in Automic environments. For example, workarounds or special instructions in the event of job aborts. Documentation thus creates transparency and can be an important tool in the context of audits.
However, the creation of documentation is time-consuming and requires daily maintenance to ensure that it is always up to date. To ensure that the information from the documentation can also be made available to different target groups, documentation is often carried out using external tools. Due to the high manual portion, standardized and always up-to-date documentation of environments is rare.
In order to optimize documentation, this solution focuses on generating automated documentation. This solution provides a standard for standardizing documentation and reducing manual effort.
The solution can generate documentation based on b4A packages. In doing so, dependencies of b4A packages are also documented and references between the documentations can be created, enabling a comprehensive view of the b4A packages.
The best4Automic Solution automatically reads the properties of objects in a b4A Package. This can be information like settings/attributes like “Generate at runtime”, contents of scripts (incl. pre- and postscript/conditions), package configurations, dependencies, versions, etc.. This information is then prepared on the basis of templates. The files generated from these templates can then be imported into any target system, such as Confluence, MediaWiki, or any other text file-based system. For example, it is equally possible to generate SVG graphics or BPMN diagrams of workflows.
