METHOD AND SYSTEM FOR ENHANCING SOFTWARE DOCUMENTATION AND HELP SYSTEMS

• US 20090138524A1
• Filed: 12/29/2008
• Published: 05/28/2009
• Est. Priority Date: 09/13/2002
• Status: Active Grant

• Current Assignee: Cadence Design Systems Incorporated (Cadence Group)
• Original Assignee: Cadence Design Systems Incorporated (Cadence Group)
• Inventors: Singh, Gurbir
• Granted Patent: US 7,937,418 B2
• Time in Patent Office: Days
• US Class Current: 1/1
• 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 method for enhancing software documentation and help systems, comprising:

creating a virtual library for a selected combination of tools;

linking said virtual library to tools in said selected combination of tools; and

storing said virtual library in a computer readable medium or displaying said virtual library on a display device.

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

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

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

5. The method of claim 1 wherein creating a virtual library comprises:

defining a project file;

creating a document list file;

deriving a serialized document list file; and

constructing a search index.

6. The method of claim 5 wherein defining a project file comprises:

specifying a project name;

identifying a path to a documentation and help system; and

indicating version information for said documentation and help system.

7. The method of claim 6 further comprising:

launching said documentation and help system; and

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

8. The method of claim 6 further comprising accessing a plurality of virtual libraries through one running instance of said documentation and help system.

9. The method of claim 6 further comprising browsing said virtual library through said documentation and help system.

10. The method of claim 6 further comprising searching said virtual library through said documentation and help system.

11. The method of claim 6 wherein said document list file is created using a compiler in said documentation and help system.

12. The method of claim 6 wherein said serialized document list file is derived using a compiler in said documentation and help system.

13. The method of claim 6 wherein said search index is constructed using an indexer in said documentation and help system.

14. The method of claim 5 wherein creating a document list file comprises:

identifying documents associated with said selected combination of tools; and

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

15. The method of claim 14 wherein said documents associated with said first selected combination of tools comprises documents having separately rooted paths.

16. The method of claim 5 wherein said serialized document list file is derived from said document list file.

17. The method of claim 5 wherein said search index is constructed from said document list file.

18. The method of claim 5 wherein creating a virtual library further comprises establishing a project list file, said project list file containing links to other virtual libraries.

19. The method of claim 5 wherein creating a virtual library further comprises specifying a path file, said path file identifying documentation hierarchies.

20. The method of claim 5 wherein creating a virtual library further comprises composing a library file.

21. The method of claim 20 wherein creating a document list file comprises generating said document list file from said library file.

22. The method of claim 20 wherein said serialized document list file is derived from said library file.

23. The method of claim 20 wherein composing a library file comprises:

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

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

24. The method of claim 23 wherein said product or family names are external names for tools in said selected combination of tools.

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

26. The method of claim 25 wherein creating a document list file comprises generating said document list file from said library file and said mapping file.

27. The method of claim 24 wherein said serialized document list file is derived from said library file and said mapping file.

28. The method of claim 1 further comprising:

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

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

29. The method of claim 28 wherein a tool is a part of both of said selected combination of tools.

30. The method of claim 29 further comprising:

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

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

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

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

means for linking said virtual library to tools in said selected combination of tools.

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

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

34. The system of claim 31 wherein means for linking said virtual library comprises means for setting an environment variable.

35. The system of claim 31 wherein means for creating a virtual library comprises:

means for defining a project file;

means for creating a document list file;

means for deriving a serialized document list file; and

means for constructing a search index.

36. An article of manufacture comprising:

a computer-readable medium having a volatile or non-volatile medium, the computer-readable medium having stored therein instructions which, when executed by a processor, cause a processing system to perform a method for enhancing software documentation and help systems, comprising;

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

linking said virtual library to tools in said selected combination of tools.

37. The article of manufacture of claim 36 wherein said selected combination of tools is selected from one or more software releases, said one or more software releases comprising a plurality of available tools, said selected combination of tools comprising less than all of said plurality of available tools, wherein said selected combination of tools comprises tools from a plurality of software releases.

38. The article of manufacture of claim 36 wherein linking said virtual library comprises setting an environment variable.

39. The article of manufacture of claim 36 wherein creating a virtual library comprises:

defining a project file;

creating a document list file;

deriving a serialized document list file; and

constructing a search index.