8832654

System and Method for Autonomous Generation of Software Documentation

PublishedSeptember 9, 2014
Assigneenot available in USPTO data we have
InventorsJames Malnati
Technical Abstract

Patent Claims
17 claims

Legal claims defining the scope of protection. Each claim is shown in both the original legal language and a plain English translation.

Claim 1

Original Legal Text

1. A method for autonomously generating documentation describing user-defined rules for computer system management, the method comprising: receiving, a documentation generator device, user-defined rules that specify management actions to be triggered responsive to occurrence of an event for managing a computer system; and processing, by the documentation generator device, the received user-defined rules for generating documentation describing the rules; wherein the documentation generator device comprises an autoaction database containing patterns specifying messages desired to be identified and corresponding autoactions to be taken; wherein generating comprises generating documentation for: user defined rules comprising message matching criteria used in comparing patterns with messages; and the corresponding autoactions to be taken comprise raising alerts to a console associated with the computer management system, activating paging devices external to the computer management system, and generating cross-system commands that may be sent to another managed compute management system.

Plain English Translation

A method for automatically creating documentation for user-defined rules used in computer system management involves a documentation generator. This generator receives rules that define actions to take when specific events occur in the managed computer system. The generator then processes these rules to produce documentation explaining them. The documentation generator uses an autoaction database containing patterns to match against system messages and associated actions. The documentation describes: the criteria used to match patterns with messages and the resulting actions, such as raising alerts on a console, activating external paging devices, or sending commands to other managed systems.

Claim 2

Original Legal Text

2. The method of claim 1 wherein said processing comprises: generating said documentation that contains identification of at least the event and the corresponding management actions triggered by the rule upon occurrence of the event.

Plain English Translation

The documentation generation method as described above (a documentation generator device receives rules that define actions to take when specific events occur in the managed computer system and processes these rules to produce documentation explaining them; the documentation generator uses an autoaction database containing patterns to match against system messages and associated actions; the documentation describes the criteria used to match patterns with messages and the resulting actions, such as raising alerts on a console, activating external paging devices, or sending commands to other managed systems) also generates documentation that specifically identifies the triggering event and the corresponding management actions that are executed because of that event.

Claim 3

Original Legal Text

3. The method of claim 1 further comprising: generating a highly-structured representation of the user-defined rules implemented within a database, wherein said receiving comprises receiving said highly-structured representation of the user-defined rules.

Plain English Translation

The documentation generation method as described above (a documentation generator device receives rules that define actions to take when specific events occur in the managed computer system and processes these rules to produce documentation explaining them; the documentation generator uses an autoaction database containing patterns to match against system messages and associated actions; the documentation describes the criteria used to match patterns with messages and the resulting actions, such as raising alerts on a console, activating external paging devices, or sending commands to other managed systems) includes an initial step of generating a highly structured representation of the user-defined rules stored in a database. The documentation generator then receives this structured representation instead of the raw rules.

Claim 4

Original Legal Text

4. The method of claim 1 wherein the event comprises a system message from a managed computer system.

Plain English Translation

In the documentation generation method (a documentation generator device receives rules that define actions to take when specific events occur in the managed computer system and processes these rules to produce documentation explaining them; the documentation generator uses an autoaction database containing patterns to match against system messages and associated actions; the documentation describes the criteria used to match patterns with messages and the resulting actions, such as raising alerts on a console, activating external paging devices, or sending commands to other managed systems), the triggering event is a system message received from a computer being managed.

Claim 5

Original Legal Text

5. The method of claim 1 further comprising: storing the generated documentation to computer-readable medium.

Plain English Translation

The documentation generation method as described above (a documentation generator device receives rules that define actions to take when specific events occur in the managed computer system and processes these rules to produce documentation explaining them; the documentation generator uses an autoaction database containing patterns to match against system messages and associated actions; the documentation describes the criteria used to match patterns with messages and the resulting actions, such as raising alerts on a console, activating external paging devices, or sending commands to other managed systems) further includes storing the generated documentation on a computer-readable storage medium.

Claim 6

Original Legal Text

6. The method of claim 5 wherein the generated documentation is contained in a computer-readable file.

Plain English Translation

In the documentation generation method where documentation is stored on a computer-readable medium (a documentation generator device receives rules that define actions to take when specific events occur in the managed computer system and processes these rules to produce documentation explaining them; the documentation generator uses an autoaction database containing patterns to match against system messages and associated actions; the documentation describes the criteria used to match patterns with messages and the resulting actions, such as raising alerts on a console, activating external paging devices, or sending commands to other managed systems), the stored documentation is contained within a computer-readable file.

Claim 7

Original Legal Text

7. The method of claim 1 further comprising: outputting the generated documentation.

Plain English translation pending...
Claim 8

Original Legal Text

8. The method of claim 1 wherein said documentation generator device comprises computer-executable software stored to a computer-readable medium that is executing on at least one processor for performing at least said processing.

Plain English Translation

In the documentation generation method (a documentation generator device receives rules that define actions to take when specific events occur in the managed computer system and processes these rules to produce documentation explaining them; the documentation generator uses an autoaction database containing patterns to match against system messages and associated actions; the documentation describes the criteria used to match patterns with messages and the resulting actions, such as raising alerts on a console, activating external paging devices, or sending commands to other managed systems), the documentation generator uses computer-executable software that runs on one or more processors to perform the processing of the rules.

Claim 9

Original Legal Text

9. A computer program product having a non-transitory computer-readable medium having computer program logic recorded thereon for autonomously generating documentation describing user-defined rules for computer system management, the computer program product comprising: code for receiving user-defined rules that specify management actions to be triggered responsive to occurrence of an event for managing a computer system; and code for generating, from processing of the received user-defined rules, documentation describing the rules; wherein the documentation generator device comprises an autoaction database containing patterns specifying messages desired to be identified and corresponding autoactions to be taken; and user defined rules comprising message matching criteria used in comparing patterns with messages; and the corresponding autoactions to be taken comprise raising alerts to a console associated with the computer management system, activating paging devices external to the computer management system, and generating cross-system commands that may be sent to another managed computer management system.

Plain English Translation

A computer program stored on a non-transitory computer-readable medium automatically generates documentation for user-defined rules in computer system management. The program includes code to receive rules that specify management actions triggered by events in a managed computer system, and code to generate documentation describing those rules by processing them. The documentation generator uses an autoaction database containing patterns specifying messages to identify, and the corresponding actions. User-defined rules use message matching criteria to compare patterns with messages. Actions include raising alerts on a console, activating external paging devices, and sending cross-system commands to other managed computer systems.

Claim 10

Original Legal Text

10. The computer program product of claim 9 wherein said code for generating comprises: code for generating said documentation containing identification of at least the event and the corresponding management actions triggered by the rule upon occurrence of the event.

Plain English Translation

The computer program as described above (code to receive rules that specify management actions triggered by events in a managed computer system, and code to generate documentation describing those rules by processing them; the documentation generator uses an autoaction database containing patterns specifying messages to identify, and the corresponding actions; user-defined rules use message matching criteria to compare patterns with messages; actions include raising alerts on a console, activating external paging devices, and sending cross-system commands to other managed computer systems) generates documentation that identifies both the triggering event and the corresponding management actions that occur.

Claim 11

Original Legal Text

11. The computer program product of claim 9 further comprising: code for generating a highly-structured representation of the user-defined rules from an implementation of the rules within a database, wherein said code for receiving comprises code for receiving said highly-structured representation of the user-defined rules.

Plain English Translation

The computer program as described above (code to receive rules that specify management actions triggered by events in a managed computer system, and code to generate documentation describing those rules by processing them; the documentation generator uses an autoaction database containing patterns specifying messages to identify, and the corresponding actions; user-defined rules use message matching criteria to compare patterns with messages; actions include raising alerts on a console, activating external paging devices, and sending cross-system commands to other managed computer systems) also includes code that generates a highly structured representation of the user-defined rules from a database implementation, and the receiving code is configured to receive this structured representation.

Claim 12

Original Legal Text

12. The computer program product of claim 9 wherein the event comprises a system message from the managed computer system.

Plain English Translation

In the computer program as described above (code to receive rules that specify management actions triggered by events in a managed computer system, and code to generate documentation describing those rules by processing them; the documentation generator uses an autoaction database containing patterns specifying messages to identify, and the corresponding actions; user-defined rules use message matching criteria to compare patterns with messages; actions include raising alerts on a console, activating external paging devices, and sending cross-system commands to other managed computer systems), the triggering event is a system message from the managed computer system.

Claim 13

Original Legal Text

13. The computer program product of claim 9 further comprising: code for storing the generated documentation to computer-readable medium.

Plain English Translation

The computer program as described above (code to receive rules that specify management actions triggered by events in a managed computer system, and code to generate documentation describing those rules by processing them; the documentation generator uses an autoaction database containing patterns specifying messages to identify, and the corresponding actions; user-defined rules use message matching criteria to compare patterns with messages; actions include raising alerts on a console, activating external paging devices, and sending cross-system commands to other managed computer systems) also includes code to store the generated documentation on a computer-readable medium.

Claim 14

Original Legal Text

14. The computer program product of claim 13 wherein the generated documentation is contained in a computer-readable file.

Plain English Translation

The computer program that stores documentation on a computer-readable medium (code to receive rules that specify management actions triggered by events in a managed computer system, and code to generate documentation describing those rules by processing them; the documentation generator uses an autoaction database containing patterns specifying messages to identify, and the corresponding actions; user-defined rules use message matching criteria to compare patterns with messages; actions include raising alerts on a console, activating external paging devices, and sending cross-system commands to other managed computer systems) saves the documentation in a computer-readable file.

Claim 15

Original Legal Text

15. The computer program product of claim 9 further comprising: code for outputting the generated documentation.

Plain English Translation

The computer program as described above (code to receive rules that specify management actions triggered by events in a managed computer system, and code to generate documentation describing those rules by processing them; the documentation generator uses an autoaction database containing patterns specifying messages to identify, and the corresponding actions; user-defined rules use message matching criteria to compare patterns with messages; actions include raising alerts on a console, activating external paging devices, and sending cross-system commands to other managed computer systems) also includes code to output the generated documentation.

Claim 16

Original Legal Text

16. A computing system for generating documentation describing user-defined rules for computer system management having a programmable processor, memory and mass storage, the computing system comprising: a database storing user-defined rules that specify management actions to be triggered, for managing a computer system, responsive to receipt of a system message from the managed computer system; and a documentation generation device configured to autonomously generate documentation describing the rules, wherein the documentation contains identification of at least the system message and the corresponding management actions triggered by the rules upon receipt of the system message; wherein the documentation generator device comprises an autoaction database containing patterns specifying messages desired to be identified and corresponding autoactions to be taken; and user defined rules comprising message matching criteria used in comparing patterns with messages; and the corresponding autoactions to be taken comprise raising alerts to a console associated with the computer management system, activating paging devices external to the computer management system, and generating cross-system commands that may be sent to another managed computer management system.

Plain English Translation

A computer system creates documentation for user-defined rules for managing a computer system. It includes a database storing rules that define actions triggered by system messages from the managed computer system. A documentation generator creates documentation from these rules, identifying the system message and its associated actions. The documentation generator uses an autoaction database containing patterns specifying messages to identify, and the corresponding actions. User-defined rules use message matching criteria to compare patterns with messages. Actions include raising alerts on a console, activating external paging devices, and sending cross-system commands to other managed computer systems.

Claim 17

Original Legal Text

17. The computing system of claim 16 further comprising: a database utility device configured to generate a highly-structured representation of the user-defined rules from the rules stored in the database, wherein the documentation generation device is configured to process said highly-structured representation of the user-defined rules to autonomously generate said documentation.

Plain English Translation

In the computer system described above (a database storing rules that define actions triggered by system messages from the managed computer system, and a documentation generator creates documentation from these rules, identifying the system message and its associated actions; the documentation generator uses an autoaction database containing patterns specifying messages to identify, and the corresponding actions; user-defined rules use message matching criteria to compare patterns with messages; actions include raising alerts on a console, activating external paging devices, and sending cross-system commands to other managed computer systems), a database utility creates a structured representation of the user-defined rules from the database. The documentation generator then processes this structured representation to generate the documentation.

Patent Metadata

Filing Date

Unknown

Publication Date

September 9, 2014

Inventors

James Malnati

Want to explore more patents?

Browse 5M+ US patents with plain-English claim translations and AI-generated analysis.

Citation & reuse

Analysis on this page is generated by Patentable — an AI-powered patent intelligence platform. AI-generated summaries, explanations, FAQs, and analysis may be reused with attribution and a visible link back to the canonical URL below. Patent abstracts and claims are USPTO public domain.

Cite as: Patentable. “SYSTEM AND METHOD FOR AUTONOMOUS GENERATION OF SOFTWARE DOCUMENTATION” (8832654). https://patentable.app/patents/8832654

© 2026 Nomic Interactive Technology LLC. Machine-readable context available at /api/llm-context/8832654. See llms.txt for full attribution policy.

SYSTEM AND METHOD FOR AUTONOMOUS GENERATION OF SOFTWARE DOCUMENTATION