Software documentation release control system

• US 5,903,897 A
• Filed: 12/18/1996
• Issued: 05/11/1999
• Est. Priority Date: 12/18/1996
• Status: Expired due to Term

• Current Assignee: Alcatel USA Sourcing L.P. (Nokia Corporation)
• Original Assignee: Alcatel USA Sourcing L.P. (Nokia Corporation)
• Inventors: Gillespie, R. John K., Carrier, David F. III, Weeks, Donald L. Jr., Lui, Janet Kwai Fun
• Primary Examiner(s): Black, Thomas G.
• Assistant Examiner(s): HOMERE, JEAN RAYMOND
• Application Number:
  US08/768,405
• Time in Patent Office: 874 Days
• Field of Search: 707/102, 707/203, 707/511, 707/531, 395/183.14
• US Class Current: 1/1
• CPC Class Codes: G06F 8/71 Version control security arrangements therefor G06F21/57; Configuration management
• CPC Class Codes: Y10S 707/99943 Generating database or data structure, e.g. via user interface
• CPC Class Codes: Y10S 707/99954 Version management

Abstract

A system and method (510) for software documentation process control includes the steps of receiving and storing check-in data related to documentation (540, 542, 544, 546, 550, 552) checked into a version control system (12). Subsequently, the documentation are associated with a specific version and release of a software product, and tags the documentation with a unique label indicative of the specific version and release of the software product. The documentation is stored in a project file directory (566) associated with the specific version and release of the software product.

Claims

1. A software documentation process control system, comprising:

a version control system operable to process at least one document and associated source module related to a predetermined version and release of a software product; and

a document collector coupled to the version control system and adapted for associating the at least one document and associated source module with the predetermined version and release of the software product;

a load builder operable to generate the predetermined version and release of the software product from selected documents and associated source modules identified with the predetermined version and release of the software product.

2. The system, as set forth in claim 1, wherein the at least one document comprises engineering specification documentation.

3. The system, as set forth in claim 1, wherein the at least one document comprises test cases and reports.

4. The system, as set forth in claim 1, wherein the at least one document comprises a standards checklist.

5. The system, as set forth in claim 1, wherein the at least one document comprises customer documentation.

6. The system, as set forth in claim 1, wherein the at least one document comprises project memoranda.

7. The system, as set forth in claim 1, wherein the at least one document comprises documents associated with load building.

8. The system, as set forth in claim 1, further comprising a project file document directory for storing the at least one document according to document classification.

9. The system, as set forth in claim 1, further comprising a project file document directory having a plurality of subdirectories for storing the at least one document according to document classification.

10. An automated method for document process control, comprising the steps of:

receiving at least one document and associated source module;

assigning a unique label indicative of a part number of a software product to the at least one document and the associated source module; and

storing the at least one document in a predetermined project file document directory;

building the software product from selected documents and associated source modules having the unique label.

11. The automated method, as set forth in claim 10, further comprising the steps of:

determining the type of the at least one document; and

storing the at least one document into a subdirectory of the project file document directory in response to the determined document type.

12. The automated method, as set forth in claim 10, further comprising the step of:

checking in the at least one document into a version control system; and

generating check-in data associated with the document.

13. The automated method, as set forth in claim 10, further comprising the step of providing an interactive user interface for displaying information, prompting data entry by users, and receiving information associated with each of the steps.

14. The automated method, as set forth in claim 10, wherein the assigning step comprises the step of assigning a feature specification documentation number to the at least one document.

15. An automated method for software file release with documentation process control, comprising the steps of:

receiving and storing check-in data related to source modules checked into a version control system;

receiving and storing check-in data related to documentation checked into the version control system;

associating the documentation with the source modules and a specific version and release of a software product;

storing the documentation in a project file document directory associated with the specific version and release of the software product; and

tagging the documentation with a unique label indicative of the specific version and release of the software product;

building the specific version and release of the software product from documentation and associated source modules identified with the specific version and release of the software product.

16. The automated method, as set forth in claim 15, further comprising the steps of:

determining the type of the documentation; and

storing the documentation into a subdirectory of a project file document directory in response to the determined document type.

17. The automated method, as set forth in claim 15, further comprising the step of providing an interactive user interface for displaying information, prompting data entry by users, and receiving information associated with each of the steps.

18. The automated method, as set forth in claim 15, wherein the tagging step comprises the step of assigning a feature specification documentation number to the at least one document.