Method and system for enhancing software documentation and help systems

• US 7,937,418 B2
• Filed: 12/29/2008
• Issued: 05/03/2011
• Est. Priority Date: 09/13/2002
• Status: Expired due to Fees

• Current Assignee: Cadence Design Systems Incorporated (Cadence Group)
• Original Assignee: Cadence Design Systems Incorporated (Cadence Group)
• Inventors: Singh, Gurbir
• Primary Examiner(s): PANNALA, SATHYANARAYA R
• Application Number:
  US12/345,621
• Publication Number:
  US 20090138524A1
• Time in Patent Office: 855 Days
• Field of Search: None
• US Class Current: 707/805
• CPC Class Codes: G06F 8/73 Program documentation
• CPC Class Codes: G06F 9/453 Help systems

Abstract

A method and system for enhancing software documentation and help systems. In one embodiment, a virtual library for a selected combination of tools is created. The virtual library is then linked to the tools in the selected combination of tools. In another embodiment, a combination of tools for designing a complex software system is selected from one or more software releases. The one or more software releases comprises a plurality of available tools. The selected combination of tools comprises less than all of the plurality of available tools. Each of the plurality of available tools is associated with one or more documents. Access to only those one or more documents associated with tools in the selected combination of tools is provided.

Claims

1. A computer implemented method for enhancing software documentation and help systems, comprising:

using a computing system that comprises at least one processor and is configured for;

creating a virtual library for a selected combination of tools; and

linking said virtual library to tools in said selected combination of tools, in which the act of creating the virtual library comprises;

defining a project file;

creating a document list file;

deriving a serialized document list file; and

constructing a search index.

2. The computer implemented method of claim 1 wherein the selected combination of tools is selected from one or more software releases, the one or more software releases comprising a plurality of available tools, the selected combination of tools comprising less than all of the plurality of available tools.

3. The computer implemented method of claim 2 wherein the selected combination of tools comprises tools from a plurality of software releases.

4. The computer implemented method of claim 1 wherein linking the virtual library comprises setting an environment variable.

5. The computer implemented method of claim 1 wherein defining a project file comprises:

specifying a project name;

identifying a path to a documentation and help system; and

indicating version information for the documentation and help system.

6. The computer implemented method of claim 5 further comprising:

launching the documentation and help system; and

sending the documentation and help system a pointer to the virtual library.

7. The computer implemented method of claim 5 further comprising accessing a plurality of virtual libraries through one running instance of the documentation and help system.

8. The computer implemented method of claim 5 further comprising browsing the virtual library through the documentation and help system.

9. The computer implemented method of claim 5 further comprising searching the virtual library through the documentation and help system.

10. The computer implemented method of claim 5, wherein the document list file is created using a compiler in the documentation and help system.

11. The computer implemented method of claim 5, wherein the serialized document list file is derived using a compiler in the documentation and help system.

12. The computer implemented method of claim 5, wherein the search index is constructed using an indexer in the documentation and help system.

13. The computer implemented method of claim 1, wherein creating a document list file comprises:

identifying documents associated with the selected combination of tools; and

specifying paths to the documents associated with the selected combination of tools.

14. The computer implemented method of claim 13 wherein the documents associated with the first selected combination of tools comprises documents having separately rooted paths.

15. The computer implemented method of claim 1, wherein the serialized document list file is derived from the document list file.

16. The computer implemented method of claim 1, wherein the search index is constructed from the document list file.

17. The computer implemented method of claim 1, wherein creating a virtual library further comprises establishing a project list file, the project list file containing links to other virtual libraries.

18. The computer implemented method of claim 1, wherein creating a virtual library further comprises specifying a path file, the path file identifying documentation hierarchies.

19. The computer implemented method of claim 1, wherein creating a virtual library further comprises composing a library file.

20. The computer implemented method of claim 19 wherein creating a document list file comprises generating the document list file from the library file.

21. The computer implemented method of claim 19 wherein the serialized document list file is derived from the library file.

22. The computer implemented method of claim 19 wherein composing a library file comprises:

identifying product or family names for tools in the selected combination of tools; and

specifying a release hierarchy for each of the product or family names.

23. The computer implemented method of claim 22 wherein the product or family names are external names for tools in the selected combination of tools.

24. The computer implemented method of claim 23 wherein creating a virtual library further comprises including a mapping file, the mapping file maps the external names for tools in the selected combination of tools to internal names for tools in the selected combination of tools.

25. The computer implemented method of claim 24 wherein creating a document list file comprises generating the document list file from the library file and the mapping file.

26. The computer implemented method of claim 23 wherein the serialized document list file is derived from the library file and the mapping file.

27. The computer implemented method of claim 1 further comprising:

creating another virtual library for another selected combination of tools; and

linking the other virtual library to tools in the other selected combination of tools.

28. The computer implemented method of claim 27 wherein a tool is a part of both of the selected combination of tools.

29. The computer implemented method of claim 28 further comprising:

invoking the tool concurrently under both selected combination of tools; and

dynamically determining which virtual library the tool accesses based upon the selected combination of tools the tool is invoked under.

30. A system having a processor for enhancing software documentation and help systems, comprising:

a computing system that comprises at least one processor and is configured for;

creating a virtual library for a selected combination of tools; and

linking the virtual library to tools in the selected combination of tools, in which the computing system that is configured for creating the virtual library is further configured for;

defining a project file;

creating a document list file;

deriving a serialized document list file; and

constructing a search index.

31. The system of claim 30, wherein the selected combination of tools is selected from one or more software releases, the one or more software releases comprising a plurality of available tools, the selected combination of tools comprising less than all of the plurality of available tools.

32. The system of claim 31 wherein the selected combination of tools comprises tools from a plurality of software releases.

33. The system of claim 30 wherein the computing system configured for linking the virtual library is further configured for setting an environment variable.

34. An article of manufacture comprising a computer readable storage medium having a volatile or non-volatile storage medium, the computer readable storage medium having stored thereupon instructions which, when executed by a processor of a processing system, cause the processing system to perform a process for enhancing software documentation and help systems, the process comprising:

creating a virtual library for a selected combination of tools; and

linking the virtual library to tools in the selected combination of tools, in which the process for creating the virtual library comprises;

defining a project file;

creating a document list file;

deriving a serialized document list file; and

constructing a search index.

35. The article of manufacture of claim 34, wherein the selected combination of tools one or more tools from one or more software releases, the one or more software releases comprising a plurality of available tools, and the selected combination of tools comprising less than all of the plurality of available tools.

36. The article of manufacture of claim 34 wherein the process for linking the virtual library comprises setting an environment variable.