Back to results
US 7,096,420 B1Granted
Method and system for automatically documenting system command file tags and generating skeleton documentation content therefrom
AssigneeCisco Technology, Inc.
InventorWendy Peikes
Life of this patent
Estimating the term…
Abstract
A method for generating documentation content for computer operating system commands with command specifications in command definition files is disclosed. The method includes examining a command definition file for a syntactic structure of a corresponding command. The command definition file has a link point, a keyword, and an argument. A documentation requirement and documentation options are extracted from the syntactic structure. The documentation requirement and the documentation options are combined into a documentation tag construct. The method automatically generates a template for a documentation content file, which includes a natural language explanation for the keyword and argument.
Claims19
In a computer operating system using commands with command specifications in command definition files, a method for generating command documentation content, said method comprising:
- a) examining a command definition file for a syntactic structure of a corresponding command, wherein said command definition file comprises a linkpoint, a keyword, and an argument;
- b) extracting a documentation requirement from said syntactic structure wherein said syntactic structure represents documentation content of said command definition file with natural language syntax;
- c) extracting documentation options from said syntactic structure wherein said documentation requirement and said documentation options correspond to a partial fraction of actual content of said command definition file;
- d) combining said documentation requirement and said documentation options into a documentation tag construct wherein said documentation tag construct is embeddable into said command definition file;
- and
- e) automatically generating a standard template for a documentation content file, wherein said document content file comprises a natural language explanation of said keyword and said argument, wherein said document content file provides a standard framework with automatically generated content and wherein said automatically generated content is end-user over-writable with at least one of documentation content and data of localized relevance to said end-user.
3 more elements
A computer system comprising:
- a bus;
- a memory coupled to said bus;
- and
- a processor coupled to said bus and implementing an operating system wherein said operating system uses commands with command specifications in command definition files, said processor performing a process for automatically generating command documentation content, said process comprising:
- a) examining a command definition file for a syntactic structure of a corresponding command, wherein said command definition file comprises a linkpoint, a keyword, and an argument;
- b) extracting a documentation requirement from said syntactic structure wherein said syntactic structure represents documentation content of said command definition file with natural language syntax;
- c) extracting documentation options from said syntactic structure wherein said documentation requirement and said documentation options correspond to a partial fraction of said actual content associated with said command definition file;
- d) combining said documentation requirement and said documentation options into a documentation tag construct wherein said documentation tag construct is embeddable into said command definition file;
- and
- e) automatically generating a standard template for a documentation content file, wherein said document content file comprises a natural language explanation of said keyword and said argument, wherein said document content file provides a standard framework with automatically generated content and wherein said automatically generated content is end-user over-writable with at least one of documentation content and data of localized relevance and to said end-user.
7 more elements
A computer usable medium having a computer readable program code embodied therein for causing a computer to perform a process for automatically generating command documentation content, said process comprising:
- a) examining a command definition file for a syntactic structure of a corresponding command, wherein said computer has an operating system using a command of a plurality of commands, said command having specifications in a command definition file and wherein, wherein said command definition file comprises a link point, a keyword, and an argument;
- b) extracting a documentation requirement from said syntactic structure wherein said syntactic structure represents documentation content of said command definition file with natural language syntax;
- c) extracting documentation options from said syntactic structure wherein said documentation requirement and said documentation options correspond to a partial fraction of said actual content associated with said command definition file;
- d) combining said documentation requirement and said documentation options into a documentation tag construct wherein said documentation tag construct is embeddable into said command definition file;
- and
- e) automatically generating a template for a documentation content file, wherein said document content file comprises a natural language explanation of said keyword and said argument, wherein said document content file provides a standard framework with automatically generated content and wherein said automatically generated content is end-user over-writable with at least one of documentation content and data of localized relevance to said end-user.
3 more elements
A system for automatically generating command documentation content for commands of a computer operating system, said system comprising:
- a) means for examining a command definition file for a syntactic structure of a corresponding command, wherein said command definition file comprises a linkpoint, a keyword, and an argument;
- b) means for extracting a documentation requirement from said syntactic structure wherein said syntactic structure represents documentation content of said command definition file with natural language syntax;
- c) extracting documentation options from said syntactic structure wherein said documentation requirement and said documentation options correspond to a partial fraction of said actual content associated with said command definition file;
- d) means for combining said documentation requirement and any said documentation option into a documentation tag construct wherein said documentation tag construct is embeddable into said command definition file;
- and
- e) means for automatically generating a template for a documentation content file, wherein said document content file comprises a natural language explanation of said keyword and said argument, wherein said document content file provides a standard framework with automatically generated content and wherein said automatically generated content is end-user over-writable with at least one of documentation content and data of localized relevance to said end-user.
3 more elements
Dependencies are inferred from the claim text.