Method and system for automatic documentation of configurable systems

• US 9,959,115 B2
• Filed: 03/11/2005
• Issued: 05/01/2018
• Est. Priority Date: 01/11/2000
• Status: Active Grant

• Current Assignee: Versata Incorporated (ESW Capital, LLC)
• Original Assignee: Ecora.com Corporation
• Inventors: Bakman, Alexander, Sabin, Daniel, Hulubei, Tudor, Wertsberger, Shalom
• Primary Examiner(s): TAPP, AMELIA L
• Application Number:
  US11/077,121
• Publication Number:
  US 20060206789A1
• Time in Patent Office: 4,799 Days
• Field of Search: 715200, 715205, 715256, 715254
• CPC Class Codes: G06F 8/71 Version control security arrangements therefor G06F21/57; Configuration management
• CPC Class Codes: G06F 8/73 Program documentation
• CPC Class Codes: G06F 9/44505 Configuring for program initiating, e.g. using registry, configuration files

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.

Claims

1. A method for automatic production of documentation for configurable computerized systems, comprising the steps of:

retrieving configuration parameters of a configurable system, said configuration parameters having values associated therewith, from said configurable system, wherein said values are associated with and indicative of at least one of software and hardware component of said configurable system, and said configuration parameters either (i) control, (ii) modify, or (iii) control and modify at least a portion of behavior of said 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.

2. The method of claim 1 further comprising the steps of:

outputting explanatory information corresponding to at least one of said configuration parameters and a value associated with said parameter; and

organizing said explanatory information, based on at least one of a content of said information and said value associated with said parameter, into a narrative format descriptive of the configuration of the configurable system, the narrative format constituting the documentation, or a portion of the documentation, for said configurable system.

3. The method of claim 1, wherein said first and second set of configuration parameters are retrieved from the same system.

4. The method of claim 1, wherein one of said first set and second set of configuration parameters is retrieved from a reference configuration system.

5. The method of claim 2, further comprising the step of constructing a table of contents for said documentation, or a portion thereof.

6. The method of claim 2, further comprising the step of generating an index of at least selected parameters of said configuration parameters, and said explanatory information, said index detailing relative location of at least one of said selected parameters and at least a portion of said explanatory information within said document.

53. The method of claim 2, wherein the documentation comprises said differences.

7. A system for automatic production of documentation for configurable computerized systems, comprising:

a first computer having data communication capability;

means for retrieving configuration parameters of a configurable system from said configurable system and communicating said parameters into said first computer, wherein said configuration parameters comprise values associated with and indicative of at least one of software and hardware component of said configurable system, and said configuration parameters either (i) control, (ii) modify, or (iii) control and modify at least a portion of behavior of said configurable system;

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.

8. The system of claim 7 further comprising:

means for generating explanatory information specific to said configurable system in accordance with said configuration parameters;

means for organizing said explanatory information, based on at least one of a content of said explanatory information and values associated with said configuration parameters, into a narrative format descriptive of the configuration of the configurable system, the narrative format constituting a documentation, or a portion of said documentation, for said configurable system; and

means for outputting said documentation.

9. The system of claim 7, wherein said first and second set of configuration parameters are retrieved from the same system.

10. The system of claim 7, wherein one of said first set and second set of configuration parameters is retrieved from a reference configuration system.

11. The system of claim 7, wherein said configurable system is a configurable system of said first computer.

54. The system of claim 8, wherein the documentation comprises said differences.

12. A system for automatic production of documentation for configurable computerized systems, comprising:

a) a collector computer program adapted to retrieve configuration parameters of at least one configurable system from said at least one configurable system, wherein said configuration parameters comprise values associated with and indicative of at least one of software and hardware component of said configurable system, and said configuration parameters either (i) control, (ii) modify, or (iii) control and modify at least a portion of behavior of said configurable system;

b) a documentation generator program communicating with said collector program, and outputting explanatory information associated with said configuration parameters; and

c) a non-transitory computer-readable medium comprising at least one of said collector computer program and said documentation generator program, 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.

13. The system of claim 12 further comprising:

a parser adapted to parse said configuration parameters into associated values and merge said values into a template; and

an output module adapted to organize said explanatory information, based on at least one of a content of said explanatory information and said values associated with said configuration parameters and to output said template with said merged values in a narrative format descriptive of the configuration of the configurable system, to form the documentation or a portion of said documentation, for said at least one configurable system.

14. The system of claim 12, wherein said first and second set of configuration parameters are retrieved from the same system.

15. The system of claim 12, wherein one of said first set and second set of configuration parameters is retrieved from a reference configuration system.

55. The system of claim 13, wherein the documentation comprises said differences.

16. 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 of said configurable system from said configurable system using said collector program, wherein said configuration parameters comprise values associated with and indicative of at least one of software and hardware component of said configurable system, and said configuration parameters either (i) control, (ii) modify, or (iii) control and modify at least a portion of behavior of said configurable system;

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.

17. The method of claim 16 further comprising outputting, using said documentation generation program, a document in a narrative format descriptive of the configuration of the configurable system, said document comprising:

i. explanatory information, regarding at least a portion of said configuration parameters;

ii. said portion of said configuration parameters; and

iii. a table of contents detailing relative location of at least certain segments of said explanatory information.

18. The method of claim 16, wherein said first and second set of configuration parameters are retrieved from the same system.

19. The method of claim 16, wherein one of said first set and second set of configuration parameters is retrieved from a reference configuration system.

56. The method of claim 17, wherein the document comprises said differences.

20. 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 with said configurable system, from said configurable system into said computer, wherein said values are associated with and indicative of at least one of software and hardware component of said configurable system, and said configuration parameters either (i) control, (ii) modify, or (iii) control and modify at least a portion of behavior of said configurable system;

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.

21. The method of claim 20 further comprising organizing said explanatory information, based on at least one of a content of said information and said value associated with said parameter, into a narrative format descriptive of the configuration of the configurable system, the narrative format constituting the documentation, or a portion of the documentation, for said configurable system.

22. The method of claim 20, wherein said first and second set of configuration parameters are retrieved from the same system.

23. The method of claim 20, wherein one of said first set and second set of configuration parameters is retrieved from a reference configuration system.

24. The method of claim 21, further comprising constructing a table of contents for said documentation, or a portion thereof.

25. The method of claim 20, further comprising maintaining an activity log detailing operations of said steps of retrieving and outputting.

26. The method of claim 20, further comprising generating an index of at least selected parameters of said configuration parameters, and said explanatory information, said index detailing relative location of at least one of said selected parameters and at least a portion of said explanatory information within said document.

57. The method of claim 20, wherein the documentation comprises said differences.

27. 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 of said configurable system from said configurable system into said computer, wherein said configuration parameters comprise values associated with and indicative of at least one of software and hardware component of said configurable system, and said configuration parameters either (i) control, (ii) modify, or (iii) control and modify at least a portion of behavior of said configurable system;

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.

28. The system of claim 27 further comprising means for organizing said explanatory information, based on at least one of a content of said explanatory information and values associated with said configuration parameters, into a narrative format descriptive of the configuration of the configurable system, the narrative format constituting a documentation, or a portion of said documentation, for said configurable system.

29. The system of claim 27, wherein said first and second set of configuration parameters are retrieved from the same system.

30. The system of claim 27, wherein one of said first set and second set of configuration parameters is retrieved from a reference configuration system.

58. The system of claim 27, wherein the documentation comprises said differences.

31. 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 of at least one configurable system from said at least one configurable system, wherein said configuration parameters comprise values associated with and indicative of

at least one of software and hardware component of said configurable system, and said

configuration parameters either (i) control, (ii) modify, or (iii) control and modify at least a portion of behavior of 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.

32. The system of claim 31 further comprising c) a documentation generator program module comprising:

i. a template having explanatory information and place holders indicating placement of one or more configuration parameters;

ii. a data parser in communication with said collector program module, said parser adapted to parse said configuration parameters into associated values and merge said values into said template; and

iii. an output module adapted to organize said explanatory information, based on at least one of a content of said explanatory information and said values associated with said configuration parameters, and to output said template with said merged values in a narrative format descriptive of the configuration of the configurable system, to form the documentation or a portion of said documentation, for said at least one configurable system.

33. The system of claim 31, wherein said first and second set of configuration parameters are retrieved from the same system.

34. The system of claim 31, wherein one of said first set and second set of configuration parameters is retrieved from a reference configuration system.

59. The system of claim 31, wherein the documentation comprises said differences.

35. A method for automated production of documentation for configurable computerized system, comprising the steps of:

retrieving configuration parameters of a configurable system from said configurable system, into a computer that is in communication with said configurable system via a network, wherein said configuration parameters comprise values associated with and indicative of at least one of software and hardware component of said configurable system, and said configuration parameters either (i) control, (ii) modify, or (iii) control and modify at least a portion of behavior of said configurable system;

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.

36. The method of claim 35, wherein said document is in a narrative format descriptive of the configuration of the configurable system.

37. The method of claim 35, wherein said document further comprises iii. a table of contents detailing relative location of at least certain segments of said explanatory information.

38. The method of claim 35, wherein said first and second set of configuration parameters are retrieved from the same system.

39. The method of claim 35, wherein one of said first set and second set of configuration parameters is retrieved from a reference configuration system.

60. The method of claim 35, wherein the document comprises said differences.

40. 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, and said configuration parameters either (i) control, (ii) modify, or (iii) control and modify at least a portion of behavior of said configurable system; and

c) a non-transitory computer-readable medium comprising said at least one software module,

wherein said configuration parameters comprise values associated with and indicative of at least one of software and hardware component of said configurable system, and

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.

41. The system of claim 40, wherein at least one software module is constructed to

i. organize said explanatory information, based on at least one of a content of said explanatory information and values associated with said configuration parameters, and

ii. output said explanatory information and said configuration parameters in a narrative format descriptive of the configuration of the configurable system, to form a document specific to an instance of said configurable system.

42. The system of claim 40, wherein said first and second set of configuration parameters are retrieved from the same system.

43. The system of claim 40, wherein one of said first set and second set of configuration parameters is retrieved from a reference configuration system.

61. The system of claim 41, wherein the document comprises said differences.

44. 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 of said configurable system, said configuration parameters having values associated therewith, from said configurable system into a computer, wherein said values are associated with and indicative of at least one of software and hardware component of said configurable system, and said configuration parameters either (i) control, (ii) modify, or (iii) control and modify at least a portion of behavior of said configurable system;

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.

45. The method of claim 44 further comprising organizing said explanatory information, based on at least one of a content of said information and said value associated with said parameter, into a narrative format descriptive of the configuration of the configurable system, the narrative format constituting the documentation, or a portion of the documentation, describing specifically said configurable software system as configured.

46. The method of claim 44, wherein said first and second set of configuration parameters are retrieved from the same system.

47. The method of claim 44, wherein one of said first set and second set of configuration parameters is retrieved from a reference configuration system.

62. The method of claim 45, wherein the documentation comprises said differences.

48. A self documenting configurable 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 of a configurable system from said computer data store, wherein said configuration parameters comprise values associated with and indicative of at least one of software and hardware component of said configurable system, and said configuration parameters either (i) control, (ii) modify, or (iii) control and modify at least a portion of behavior of said configurable system; and

b) a second software module constructed to merge explanatory information and related parameters of at least said portion of said configuration parameters; and

c) a non-transitory computer-readable medium comprising at least one of said first and second software modules,

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.

49. The system of claim 48, wherein said second software module is further constructed to organize said explanatory information, based on at least one of a content of said information and values associated with said relates parameters, into a narrative format descriptive of the configuration of the configurable system, the narrative format constituting a document, or a portion of the document, containing a description specific to said configurable system.

50. The system of claim 48 wherein said first and second module constitute a single module.

51. The system of claim 48, wherein said first and second set of configuration parameters are retrieved from the same system.

52. The system of claim 48, wherein one of said first set and second set of configuration parameters is retrieved from a reference configuration system.

63. The system of claim 49, wherein the document comprises said differences.