Automatically updating documentation

    公开(公告)号:US11132193B1

    公开(公告)日:2021-09-28

    申请号:US17137466

    申请日:2020-12-30

    IPC分类号: G06F8/73 G06F8/71

    摘要: A method for updating documentation comprising: documenting a marked segment in a documentation object, the marked segment comprising at least part of a version of a source file managed by a file version control system (VCS), where the documentation object comprises a copy of the marked segment documented thereby; identifying in the VCS a new version of the source file, where the new version was added to the VCS after the version of the source file having the marked segment; performing an identification of when an updated segment in the new version, equivalent to the marked segment, is different from the marked segment; and in response to the identification: classifying the updated segment according to differences identified between the updated segment and the copy of the marked segment; and generating an updated documentation object by modifying the copy of the marked segment according to the classification and the identified differences.

    Automatically updating documentation

    公开(公告)号:US11847444B2

    公开(公告)日:2023-12-19

    申请号:US17481346

    申请日:2021-09-22

    IPC分类号: G06F8/73 G06F8/71

    CPC分类号: G06F8/73 G06F8/71

    摘要: A method comprises executing a code in a development environment for: documenting versions of source files of a software program in a plurality of source documentation objects, where at least one of the source documentation objects comprises a textual description comprising one or more text-extracts, each text-extract comprising at least one marked token extracted from one of the versions of the source files; accessing a new version of a source file; performing an identification of when at least one updated token in the new version is different from the marked token; and in response to the identification: classifying the updated token according to differences identified between the updated token and the marked token; and subject to the classification being a member of a set of updatable changes, generating an updated source documentation object by modifying the text-extract in the textual description according to the classification and the differences.

    Automatic generation of documentation using coding patterns

    公开(公告)号:US12050909B2

    公开(公告)日:2024-07-30

    申请号:US17968879

    申请日:2022-10-19

    摘要: A method for generating documentation text comprises: extracting, from a plurality of source files of a software program, a plurality of element identifiers, each identifying an element of the software program; selecting a set of selected element identifiers of the plurality of element identifiers according to a plurality of scores, each score computed for an element identifier of the plurality of element identifiers; and for each of the set of selected element identifiers: generating an element documentation text using a documentation template and a plurality of patterns identified in a plurality of usage instances where in each of the plurality of usage instances the selected element identifier exists in at least one of the plurality of source files; and adding the element documentation text to a repository of documentation text associated with the plurality of source files.