Software documentation generation using differential upgrade documentation
View Patent ↗A software application includes a document generator. A user can download from an upgrade website documentation (e.g., release notes) describing the differences in operation between a post-upgrade version of the application that would result if a target upgrade is implemented and a pre-upgrade version of the application, e.g., the one available on the user computer system. The document generator can generate full documentation for the post-upgrade version from the pre-upgrade documentation and the upgrade documentation. The post-upgrade documentation has a revision display mode and a non-revision display mode, the former showing the changes from the operation of the pre-upgrade version to the operation of the post-upgrade version.
1. A method comprising:
downloading from an upgrade Internet site to a user computer system upgrade documentation, said upgrade Internet site also providing for downloading upgrades for a pre-upgrade version of an executable application program, said upgrade documentation describing the differences in operation between a post-upgrade version of said application program and said pre-upgrade version, the operation of said pre-upgrade version being described by pre-upgrade documentation stored on said user computer system; and
generating on said user computer system post-upgrade documentation for said application program by modifying said pre-upgrade documentation in accordance with said upgrade documentation, said post-upgrade documentation including a delta picker that a user can control to select between a clean format and a revision format of said post-upgrade documentation.
2. A method as recited in claim 1 wherein:
said revision format indicates differences in operation between said pre-upgrade version and said post-upgrade version.
3. A method as recited in claim 2 wherein:
said clean format does not indicate differences between said pre-upgrade version and said post-upgrade version.
4. A method as recited in claim 1 wherein said generating step is implemented by said pre-upgrade version of said application or said post-upgrade version of said application program.
5. A method as recited in claim 1 wherein said generating step is implemented by a program on said user computer system other than one of said versions of said application program.
6. Computer-readable storage media comprising:
a pre-upgrade version of an executable application program installed on a user computer system;
pre-upgrade electronic documentation for said application program installed on said user computer system; and
an executable documentation generator installed on said user computer system, said documentation generator generating post-upgrade documentation as a function of said pre-upgrade documentation and upgrade differential documentation associated with an upgrade of said application program, said post-upgrade documentation describing the operation of a post-upgrade version of said application program in the event said upgrade is implemented, said post-upgrade documentation including a delta picker that a user can control to select between a clean view and a revision view of said post-upgrade documentation.
7. Computer-readable storage media as recited in claim 1 further comprising upgrade software for implementing said upgrade and said upgrade documentation stored on said user computer.
8. Computer-readable storage media as recited in claim 1 wherein said post-upgrade documentation describes differences in the operation of said pre-upgrade version and said post-upgrade version.
9. Computer-readable storage media as recited in claim 8 wherein said post-upgrade documentation provides for revision-format comparisons between said pre-upgrade version and a third version of said application program.
10. Computer-readable storage media as recited in claim 9 wherein said post-upgrade documentation also provides for a clean format describing said third version of said application program.
11. Computer-readable storage media as recited in claim 1 wherein said document generator is integral with said application program.
12. Computer-readable storage media as recited in claim 1 wherein said document generator is a software program distinct from said application program.