SOFTWARE DOCUMENTATION GENERATION WITH AUTOMATED SAMPLE INCLUSION

摘要

Automated creation of augmented documentation fragments that are augmented with usage examples. A plurality of documentation fragments is stored, where each documentation fragment documents a software element and has at least one associated property. A corresponding source code software fragment that corresponds to at least one associated property of at least one software element is identified based on an automated software analysis process of source code within a source code repository and further based on a list of properties comprising each associated property of each software element within the plurality of software elements. An augmented documentation fragment that includes a selected documentation fragment and the at least one corresponding source code software fragment corresponding to at least one associated property of the selected documentation fragment is created in response to the identifying.

主权项

1. A method of forming documentation for a software element, the method comprising:
storing a plurality of documentation fragments, each documentation fragment within the plurality of documentation fragments documenting a respective software element within a plurality of software elements, each documentation fragment having at least one associated property associated with its respective software element; identifying, for a selected documentation fragment documenting a selected software element based on an automated software analysis process of source code within a source code repository and further based on a list of properties comprising each associated property of each software element within the plurality of software elements, at least one example source code software fragment from within the source code repository, the at least one example source code fragment depicting, within the at least one example source code software fragment, a usage of the selected software element. the at least one example source code software fragment being selected based on a determination the at least one example source code software fragment corresponds to the at least one associated property of the selected documentation fragment; and adding, based on the identifying, the at least one example source code software fragment to the selected documentation fragment to create an augmented documentation fragment that defines a presentation of the selected documentation fragment together with the at least one example source code software fragment.