Computer-based structures and methods for generating, maintaining, and modifying a source document and related documentation

• US 20040186817A1
• Filed: 05/17/2002
• Published: 09/23/2004
• Est. Priority Date: 10/31/2001
• Status: Abandoned Application

• Current Assignee: Metacyber Net
• Original Assignee: Metacyber Net
• Inventors: Duckett, Steven W., Thames, Joseph M.
• Application Number:
  US10/147,694
• Publication Number:
  US 20040186817A1
• Time in Patent Office: Days
• US Class Current: 707/1
• CPC Class Codes: G06F 8/71 Version control security arrangements therefor G06F21/57; Configuration management
• CPC Class Codes: G06F 8/73 Program documentation

Abstract

A system functions as a composite facility for documentation, maintenance, composition, and testing of information in a source file. A documentation generator converts the source file into exploded detail documentation in a cradle file system from which exploded-view virtual reality displays are generated. For software program code maintenance, a software application source code maintenance controller maintains the cradle file system in a reversible historical and multi-lineal version lattice via an industry-standard revision control system. A website composer utilizes information on cradle file system to support interactive artistic graphical and textual composition of web-displays. A testing and verification manager utilizes information on cradle file system to support the synthesis and maintenance of regression tests and the debugging of software program code from the context of the exploded-view virtual reality displays. Hence, the system functions as scaffolding that supports integrated, all-in-one documentation of contained software systems.

Claims

1. A system comprising:

a document generator wherein said document generator creates a memory-resident rapid comprehension documentation for source information wherein said rapid comprehension documentation includes said source information and at least one auto-generic annotation for an element in said source information and further wherein said at least one auto-generic annotation is automatically generated upon processing of said source information by said document generator; and

an information maintenance controller coupled to said document generator, wherein said information maintenance controller maintains revision control for both said source information and said at least one auto-generic annotation.

2. The system of claim 1 wherein said document generator further comprises a source information adapter.

3. The system of claim 2 wherein said source information adapter further comprises:

a memory;

an information patcher coupled to said memory wherein said information patcher generates, in said memory, a line patches hash containing information characterizing at least one patch from said source information.

4. The system of claim 3 wherein said source information adapter further comprises:

a parser-hasher coupled to said memory to access said line patches hash, wherein said parser-hasher converts said source information into a memory-resident aggregate database including (i) said source information, and (ii) said at least one auto-generic annotation for said source information.

5. The system of claim 3 wherein said source information adapter further comprises:

a parser-hasher coupled to said memory to access said line patches hash, wherein said parser-hasher parses at least one patch in said source information and generates (i) a symbol hash including a symbol name of a name symbol and (ii) an annotation hash containing an auto-generic annotation associated with said name symbol.

6. The system of claim 4 wherein said source information adapter explodes said memory-resident aggregate database into a hierarchical memory structure.

7. The system of claim 6 wherein said hierarchical memory structure comprises a metatree.

8. The system of claim 6 wherein said hierarchical memory structure comprises a global metatree.

9. The system of claim 7 wherein said metatree further comprises:

a root directory for a module in said source information.

10. The system of claim 9 wherein said metatree further comprises:

a globalized statistics hash file in said root directory.

11. The system of claim 9 wherein said metatree further comprises:

a globalized symbol hash file in said root directory.

12. The system of claim 9 wherein said metatree further comprises:

an at location file in said root directory wherein said at location file includes metatree paths.

13. The system of claim 9 wherein said metatree further comprises:

a plurality of patch subdirectories in said root directory where each patch subdirectory stores source information for that patch, and stores auto-generically generated interpretative information for said source information for that patch.

14. The system of claim 7 wherein said metatree is a diversion metatree.

15. The system of claim 8 wherein said global metatree further comprises a plurality of module subdirectories.

16. The system of claim 1 further comprising:

a cradle file system coupled to said document generator and to said information maintenance controller, and having stored therein a structure comprising;

said source information; and

auto-generically generated interpretative information including said at least one auto-generic annotation wherein said auto-generically generated interpretive information is automatically generated upon processing of said source information by said document generator.

17. The system of claim 16 wherein said structure comprises a metatree.

18. The system of claim 17 wherein said structure further comprises a global metatree.

19. The system of claim 17 wherein said metatree further comprises:

a root directory for a module in said source information.

20. The system of claim 19 wherein said metatree further comprises:

a globalized statistics hash file in said root directory.

21. The system of claim 19 wherein said metatree further comprises:

a globalized symbol hash file in said root directory.

22. The system of claim 19 wherein said metatree further comprises:

an at location file in said root directory wherein said at location file includes metatree paths.

23. The system of claim 19 wherein said metatree further comprises:

a plurality of patch subdirectories in said root directory where each patch subdirectory stores source information for that patch, and stores auto-generically generated interpretative information for said source information for that patch.

24. The system of claim 17 wherein said metatree is a diversion metatree.

25. The system of claim 18 wherein said global metatree further comprises a plurality of module subdirectories.

26. The system of claim 18 wherein said global metatree further comprises a set of files including one file for each global name symbol contained in said source information.

27. The system of claim 18 wherein said global metatree is an undifferentiated global metatree.

28. The system of claim 18 wherein said global metatree is a diversion global metatree.

29. The system of claim 1 wherein said source information is a computer program source file and said system further comprises:

a cradle file system coupled to said document generator and to said information maintenance controller, and having stored therein a structure comprising;

a metatree further comprising;

a root directory for a module in said computer program source file;

a patch subdirectory in said root directory;

a patch file in said patch subdirectory wherein said patch file comprises original source code of one patch in said module.

a symbol reference statistics file in said patch subdirectory wherein said symbol reference statistics file comprises symbol reference statistics data for name symbols referring to elements in said original source code of said patch in said module;

a generic annotation file in said patch subdirectory wherein said generic annotation file comprises auto-generically generated interpretative information for said original source code in said patch in said module;

an application specific annotation file in said patch subdirectory wherein said application specific annotation file comprises specific interpretative information for said original source code in one patch in said module; and

a set of scope subdirectories in said patch subdirectory wherein each scope subdirectory in said set is defined by a namespace for a set of name symbols wherein said each scope subdirectory includes a file for each name symbol belonging to a scope for said each scope subdirectory.

30. The computer memory of claim 29 wherein said structure further comprises a global metatree.

31. The computer memory of claim 30 wherein said global metatree further comprises a plurality of module subdirectories.

32. The computer memory of claim 31 wherein said global metatree further comprises a set of files including one file for each global name symbol contained in said computer program source file.

33. The system of claim 1 further comprising:

a memory-based metatree coupled to said document generator wherein said memory-based metatree stores data, including (i) said source information and (ii) annotations for said source information, in a hierarchical structure;

wherein said document generator further comprises;

a memory, coupled to memory-based metatree, having stored therein a plurality of hashes wherein said plurality of hashes store information including said source information and said annotations for said source information; and

a hypertext page generator coupled to said memory wherein said hypertext page generator uses said information stored in said plurality of hashes to generate said memory-resident rapid comprehension documentation for said source information.

34. The system of claim 33 wherein said source information is a computer program code module.

35. The system of claim 34 wherein said plurality of hashes includes a patch code hash including said computer program module divided into identifiable patches.

36. The system of claim 34 wherein said plurality of hashes includes an annotation hash including said at least one auto-generic annotation.

37. The system of claim 34 wherein said plurality of hashes includes a symbol hash including a name of at least one name symbol and a scope of said at least one name symbol.

38. The system of claim 37 wherein said plurality of hashes comprises a symbol reference statistics hash including statistics for references to said at least one name symbol.

39. The system of claim 38 wherein said symbol hash further comprises a reference key into said symbol reference statistics hash.

40. The system of claim 33 wherein said memory-resident rapid comprehension documentation comprises a plurality of webpages.

41. The system of claim 40 where said plurality of webpages comprises:

a plurality of patch webpages wherein at least one patch webpage in said plurality of patch webpages includes;

at least a portion of a patch in said source information; and

a plurality of annotation trigger symbols.

42. The system of claim 41 where said at least one patch webpage further comprises:

a plurality of annotations for information in said at least said portion of said patch,

wherein each annotation in said plurality of annotations is associated with a different one of said plurality of annotation trigger symbols; and

at least one annotation in said plurality of annotations is said at least one auto-generic annotation.

43. The system of claim 1 wherein said memory-resident rapid comprehension documentation for source information further comprises:

a pre-formatted information layer comprising;

a plurality of patch webpages wherein at least one patch webpage in said plurality of patch webpages includes (i) at least a portion of a patch in said source information and (ii) an annotation trigger symbol; and

a description and annotation layer comprising;

said at least one auto-generic annotation

wherein said at least one auto-generic annotation is coupled to said annotation trigger symbol.

44. The system of claim 43 wherein upon display of said at least one patch webpage, said at least one auto-generic annotation remains hidden.

45. The system of claim 44 wherein upon occurrence of a predefined event associated with said annotation trigger symbol, said at least one auto-generic annotation is displayed as a tooltip.

46. The system of claim 43 wherein said at least one auto-generic annotation includes an external link.

47. The system of claim 46 wherein said external link comprises a link to a help-summary webpage.

48. The system of claim 47 wherein said help-summary webpage comprises a link to another document.

49. The system of claim 43 wherein said annotation trigger symbol is a name symbol.

50. The system of claim 49 wherein said name symbol is a hyperlink to a name symbol cross-reference webpage.

51. The system of claim 43 wherein said annotation trigger symbol is a name symbol.

52. The system of claim 51 wherein said name symbol is a hyperlink to another patch webpage in said plurality of patch webpages.

53. The system of claim 43 wherein said annotation trigger symbol is a punctuation symbol.

54. The system of claim 43 wherein said annotation trigger symbol is text.

55. The system of claim 43 wherein said annotation trigger symbol is a blank space.

56. The system of claim 43 wherein said annotation trigger symbol is a text delimiter.

57. The system of claim 44 wherein upon occurrence of a predefined event associated with said annotation trigger symbol, a corresponding annotation trigger symbol is highlighted in said display of said at least one patch webpage.

58. The system of claim 43 wherein said description and annotation layer further comprises:

at least one auto-specific annotation for information in said at least said portion of said patch; and

wherein said at least one patch webpage further comprises;

an annotation trigger symbol for said at least one auto-specific annotation.

59. The system of claim 58 wherein said at least one auto-specific annotation comprises a comment in said source information.

60. The system of claim 58 wherein upon display of said at least one patch webpage, said at least one auto-specific annotation remains hidden.

61. The system of claim 60 wherein upon occurrence of a predefined event associated with said annotation trigger symbol for said at least one auto-specific annotation, said at least one auto-specific annotation is displayed as a tooltip.

62. The system of claim 58 wherein said at least one auto-specific annotation includes an external link.

63. The system of claim 62 wherein said external link comprises a link to a help-summary webpage.

64. The system of claim 63 wherein said help-summary webpage comprises a link to another document.

65. The system of claim 58 wherein said annotation trigger symbol for said at least one auto-specific annotation is a name symbol.

66. The system of claim 65 wherein said name symbol is a hyperlink to a name symbol cross-reference webpage.

67. The system of claim 58 wherein said annotation trigger symbol for said at least one auto-specific annotation is a function symbol.

68. The system of claim 67 wherein said function symbol is a hyperlink to another patch webpage in said plurality of patch webpages.

69. The system of claim 43 wherein said description and annotation layer further comprises:

at least one manual-specific annotation for information in said at least said portion of said patch; and

wherein said at least one patch webpage further comprises;

an annotation trigger symbol for said at least one manual-specific annotation.

70. The system of claim 69 wherein upon display of said at least one patch webpage, said at least one manual-specific annotation remains hidden.

71. The system of claim 70 wherein upon occurrence of a predefined event associated with said annotation trigger symbol for said at least one manual-specific annotation, said at least one manual-specific annotation is displayed as a tooltip.

72. The system of claim 43 further comprising:

a synopsis layer comprising;

a plurality of patch heading webpages wherein at least one patch heading webpage in said plurality of patch heading webpages includes at least a title of said patch in said source information.

73. The system of claim 72 wherein said at least one patch heading webpage includes a synopsis of said patch in said source information.

74. The system of claim 73 wherein said synopsis includes a link to additional information.

75. The system of claim 43 further comprising:

a menu layer comprising at least one module index webpage.

76. The system of claim 75 wherein said menu layer further comprises at least one patch index page webpage wherein said at least one patch index page webpage is linked to an entry in said at least one module index webpage.

77. The system of claim 43 further comprising:

a menu layer comprising at least one patch index webpage.

78. The system of claim 43 wherein said pre-formatted information layer further comprises:

a plurality of hyperlinks in said plurality of patch webpages wherein said plurality of hyperlinks is used to emulate flow of said source information.

79. The system of claim 43 wherein said pre-formatted information layer further comprises:

a sidebar menu webpage wherein said at least one patch webpage further comprises a hyperlink to said sidebar menu webpage.

80. The system of claim 79 wherein said sidebar menu webpage comprises a name symbol cross-reference webpage and said hyperlink to said sidebar webpage comprises a name symbol.

81. The system of claim 80 wherein said name symbol cross-reference webpage includes a context in which a source element represented by said name symbol occurs and a line number within the context where the name symbol occurs.

82. The system of claim 80 wherein said name symbol cross-reference webpage includes a name symbol description of an element represented by said name symbol.

83. The system of claim 80 wherein said description and annotation layer further comprises:

at least one annotation for said name symbol description; and

wherein said name symbol cross-reference webpage further comprises;

an annotation trigger symbol for said at least one annotation for said name symbol description.

84. The system of claim 83 wherein upon display of said name symbol cross-reference webpage, said at least one annotation for said name symbol description remains hidden.

85. The system of claim 83 wherein upon occurrence of a predefined event associated with said annotation trigger symbol for said at least one annotation for said name symbol description, said at least one annotation for said name symbol description is displayed as a tooltip.

86. The system of claim 1 further comprising:

a computer-based user interface comprising;

a patch heading frame wherein said patch heading frame displays identifying information for a patch in a plurality of patches in said source information; and

a patch code frame wherein said patch code frame displays information for said patch.

87. The system of claim 86 wherein said computer-based user interface further comprises:

a sidebar menu frame wherein said sidebar menu frame displays a cross-reference menu for a program element identifier symbol in said information for said patch.

88. The system of claim 1 further comprising:

a computer-based user interface comprising;

a patch code frame wherein said patch code frame displays information for a patch; and

a sidebar menu frame wherein said sidebar menu frame displays a cross-reference menu for a program element identifier symbol in said information for said patch.

89. The system of claim 1 where said document generator further comprises an annotator structure coupled to memory-resident rapid comprehension documentation for said source information

90. The system of claim 89 wherein said annotator structure further comprises:

a webpage including a plurality of annotator form presentation functions; and

at least one webpage including;

information including a plurality of annotation trigger symbols;

a plurality of annotations for said information,

wherein each annotation in said plurality of annotations is associated with a different one of said plurality of annotation trigger symbols; and

at least one call to one annotator form presentation function in said plurality of annotator form presentation functions wherein said at least one call to one annotator form presentation function is associated with one of said plurality of annotation trigger symbols.

91. The system of claim 90 where each annotator form presentation function in said plurality of annotator form presentation functions, upon execution, generates a different popup entry-edit form.

92. The system of claim 91 wherein said popup entry-edit form includes a first window and a second window.

93. The system of claim 92 wherein said first window is for displaying content having a read-only attribute.

94. The system of claim 93 wherein said content comprises auto-generic content.

95. The system of claim 92 wherein said second window is for displaying content having a read-write attribute.

96. The system of claim 95 wherein said content comprises manual-specific content.

97. The system of claim 91 wherein said popup entry-edit form includes a plurality of display configuration blend options.

98. The system of claim 91 wherein said popup entry-edit form comprises an annotator popup patch heading frame entry-edit form.

99. The system of claim 91 wherein said popup entry-edit form comprises an annotator popup sidebar menu frame entry-edit form.

100. The system of claim 91 wherein said popup entry-edit form comprises an annotator popup patch code frame name symbol reference entry-edit form.

101. The system of claim 91 wherein said popup entry-edit form comprises an annotator popup patch code frame function reference entry-edit form.

102. The system of claim 91 wherein said popup entry-edit form comprises an annotator popup footnote annotation trigger symbol entry-edit form.

103. The system of claim 90 further comprising:

a plurality of annotator agent functions wherein each of said plurality of annotator agent functions corresponds to a different annotator form presentation function in said plurality of annotator form presentation functions.

104. The system of claim 103 wherein at least one of said plurality of annotator agent functions, upon execution, updates a metatree.

105. The system of claim 103 wherein at least one of said plurality of annotator agent functions, upon execution, updates said at least one-web page.

106. The system of claim 1 further comprising:

an archived memory-based metatree including said source information and annotations for said source information wherein said annotations include said at least one auto-generic annotation.

107. The system of claim 106 wherein said information maintenance controller further comprises:

a revision control system, coupled to said archived memory-based metatree, wherein said revision control system processes a change to said annotations for a change to said source information.

108. The structure of claim 107 wherein said revision control system includes a checkout process for said archived metatree wherein a user is provided with a clone of said source information and said annotations included in said archived metatree.

109. The structure of claim 107 wherein said revision control system includes a check-in process for modified source information, wherein said modified source information is a modification of said source information.

110. The structure of claim 109 wherein said check-in process includes requiring said user to provide a manual-specific annotation for said modification.

111. The structure of claim 109 wherein said check-in process includes generating an auto-generic annotation for said modification.

112. The structure of claim 109 wherein said check-in process includes generating an auto-specific annotation for said modification.

113. The structure of claim 109 wherein said check-in process is for a main trunk sequence of revision progression.

114. The structure of claim 109 wherein said check-in process is for a branch sequence of revision progression.

115. The structure of claim 109 wherein said check-in process further comprises:

repartitioning said modified source information into patch files in a denuded metatree without generating annotations.

116. The structure of claim 115 wherein said check-in process further comprises:

deleting patch files in a working metatree.

117. The structure of claim 116 wherein said check-in process further comprises:

copying said patch files in the denuded metatree into said working metatree.

118. The structure of claim 116 wherein said check-in process further comprises:

updating said patch files in said working metatree using corresponding patch files in said archived metatree to generate a list of revised patches.

119. The structure of claim 118 wherein said check-in process further comprises:

identifying whether a conflict exists between a patch file in said working metatree and a corresponding patch file in said archived metatree.

120. The structure of claim 119 wherein said check-in process further comprises:

requiring a user to resolve said conflict upon said identifying determining that said conflict exists.

121. The structure of claim 118 wherein said check-in process further comprises:

reparsing each patch in said list of revised patches to generate auto-generic annotations for said modified source information.

122. The structure of claim 121 wherein said check-in process further comprises:

reconciling annotation reference keys for auto-specific annotations.

123. The structure of claim 122 wherein said check-in process further comprises:

committing a metatree including patches for said modified source information to a metatree archive as a revised version of said archived metatree.

124. The structure of claim 107 wherein said revision control system includes:

detecting changes to said source information.

125. The structure of claim 124 wherein said revision control system includes:

finding annotations corresponding to said changes.

126. The structure of claim 125 wherein said revision control system includes:

presenting to a user an opportunity for revising said annotations to match the changes.

127. The structure of claim 126 wherein said revision control system includes:

maintaining a log of revisions made by said user.

128. A system comprising:

a cradle file system;

a document generator coupled to said cradle file system wherein said document generator creates a metatree structure on said cradle file system, said metatree structure comprising;

source information; and

auto-generically generated interpretative information for said source information wherein said auto-generically generated interpretive information is automatically generated upon processing of said source information by said document generator.

129. The system of claim 128 wherein said metatree structure further comprises manual-specific interpretative information for said source information wherein said manual-specific interpretive information is generated upon processing of information entered by a user.

130. A system comprising:

a cradle file system;

a document generator coupled to said cradle file system wherein said document generator creates a metatree structure on said cradle file system, said metatree structure comprising;

source information; and

manual-specific interpretative information for said source information wherein said manual-specific interpretive information is generated upon processing of information entered by a user.