Method and system for automatic documentation of configurable systems
4 Assignments
0 Petitions
Accused Products
Abstract
An automatic documentation generation and management system and method, for documenting configurable systems such as complex software applications and hardware systems is disclosed. The method retrieves configuration parameters from the configurable system and utilizes them to automatically generate an explanatory document specific to the configured system. The invention also discloses a documentation appliance system, which is a dedicated documentation server coupled to the configurable system via a communication network, preferably via an Intranet. In yet another alternative, the invention may be practiced by integrating code for automatic documentation generation within the configurable system program.
52 Citations
142 Claims
-
1-90. -90. (canceled)
-
91. A method for automatic production of documentation for configurable computerized systems, comprising the steps of:
-
retrieving configuration parameters having values associated therewith, from a configurable system;
storing a first set of configuration parameters from a configurable system;
storing a second set of configuration parameters from a configurable system; and
outputting differences between said first and second sets of configuration parameters. - View Dependent Claims (92, 93, 94, 95, 96)
-
-
97. A system for automatic production of documentation for configurable computerized systems, comprising:
-
a first computer having data communication capability;
means for retrieving configuration parameters from a configurable system and communicating said parameters into said first computer;
means for storing at least a first and a second set of said configuration parameters; and
means for outputting said difference between said first and second set. - View Dependent Claims (98, 99, 100, 101)
-
-
102. A system for automatic production of documentation for configurable computerized systems, comprising:
-
a) a collector computer program adapted to retrieve configuration parameters from at least one configurable system; and
b) a documentation generator program communicating with said collector program, and outputting explanatory information associated with said configuration parameters, wherein said system is further adapted to store at least a first and a second set of said configuration parameters and to output difference between said first and second set. - View Dependent Claims (103, 104, 105)
-
-
106. A method for automated production of documentation for configurable computerized system, comprising the steps of:
-
downloading a collector computer program to a first computer which is in communication with a configurable system;
collecting configuration parameters from said configurable system using said collector program;
transmitting said configuration parameters into a second computer having a documentation generator program operable thereon;
storing a first and a second set of configuration parameters;
comparing said first set and second set; and
outputting differences therebetween. - View Dependent Claims (107, 108, 109)
-
-
110. A method for automatic production of documentation for configurable computerized systems, comprising the steps of:
-
coupling a computer with at least a portion of a configurable system via a network;
retrieving configuration parameters having values associated therewith, from said configurable system into said computer;
outputting explanatory information corresponding with at least one of said configuration parameters and a value associated with said parameter;
storing a first set of configuration parameters from a configurable system;
storing a second set of configuration parameters from a configurable system; and
outputting differences between said first and second sets of configuration parameters. - View Dependent Claims (111, 112, 113, 114, 115, 116)
-
-
117. A system for automatic production of documentation for configurable computerized systems, comprising:
-
a computer adapted to be coupled to a configurable system via a network;
means for retrieving configuration parameters from said configurable system into said computer;
means for generating explanatory information specific to said configurable system in accordance with said configuration parameters;
means for outputting said documentation; and
means for storing at least a first and a second set of said configuration parameters, wherein said means for outputting said documentation is further adapted to output difference between said first and second set. - View Dependent Claims (118, 119, 120)
-
-
121. A system for automatic production of documentation for configurable computerized systems, comprising:
-
a) a computer coupled to said configurable system via a network; and
b) a collector program module operated on said computer and adapted to retrieve configuration parameters from at least one configurable system;
wherein said system is adapted to store at least a first and a second set of said configuration parameters and to output difference between said first and second set. - View Dependent Claims (122, 123, 124)
-
-
125. A method for automated production of documentation for configurable computerized system, comprising the steps of:
-
retrieving configuration parameters from a configurable system, into a computer that is in communication with said configurable system via a network;
selecting explanatory information in accordance with said configuration parameters;
outputting a document comprising;
i. said explanatory information; and
ii. values associated with said configuration parameters;
storing a first and a second set of configuration parameters; and
comparing said first set and second set and outputting differences therebetween. - View Dependent Claims (126, 127, 128, 129)
-
-
130. A self documenting configurable system, comprising:
-
a) explanatory information related to said configurable system; and
b) at least one software module constructed to merge a plurality of configuration parameters of said configurable system with corresponding portions of said explanatory information related to said configurable system, wherein said system is adapted to store at least a first and a second set of said configuration parameters and to output difference between said first and second set. - View Dependent Claims (131, 132, 133)
-
-
134. A method for automated production of documentation for a configurable software system, having at least a portion of its behavior modifiable by configuration parameters stored in a computer accessible store, said method comprising the steps of:
-
embedding into said configurable software system a software module constructed to merge configuration parameters and explanatory information associated with said configuration parameters;
retrieving said configuration parameters, said configuration parameters having values associated therewith, from said configurable system into a computer;
outputting explanatory information corresponding with at least one of said configuration parameters and a value associated with said parameter;
storing a first and a second set of configuration parameters; and
comparing said first set and second set and outputting differences therebetween. - View Dependent Claims (135, 136, 137)
-
-
138. A self documenting configurable software system having configuration parameters stored in at least one computer data store, comprising:
-
a) a first software module constructed to retrieve at least a portion of said configuration parameters from said computer data store; and
c) a second software module constructed to merge explanatory information and related parameters of at least said portion of said configuration parameters, wherein said system is adapted to store at least a first and a second set of said configuration parameters and to output difference between said first and second set. - View Dependent Claims (139, 140, 141, 142)
-
Specification