Dynamic Software Documentation via Collaborative Editing
Find Innovative SolutionsGenerate Solutions
Solution Overview
Problem
Existing software documentation methods are either static and outdated or disconnected from the software, leading to increased costs and integrity issues due to coordination challenges between developers and technical writers, and often lack timely updates or multilingual support.
Innovation Solution
A system and method for generating dynamic software documentation that allows authorized users to edit, add, or delete information within the documentation via a network of computers, enabling simultaneous access and modification, with a server-based database and communication link facilitating bi-directional communication and using a wiki-like engine for collaborative editing.
Engineering Contradictions & Design Principles
Engineering Contradiction Analysis
1Reliability
If software documentation is provided as static documents shipped with the software product, then the documentation can be included with the software package, but the documentation becomes outdated over time as the software changes and cannot be easily updated
Solution Approach 1:
The patent transforms static documentation into dynamic documentation by implementing a database-driven system where help information is stored in a database and can be dynamically updated. The system uses version control and allows authorized users to modify documentation without requiring software reinstallation, making the documentation adaptive to software changes while maintaining reliability through controlled update mechanisms.
Solution Approach 2:
The patent enables end-users to directly edit and update documentation through an integrated interface without requiring vendor intervention. Users can identify outdated information and correct it themselves, eliminating the need for vendors to manually update documentation with every software release. This self-service capability ensures documentation remains current while reducing vendor resource requirements.
2Adaptability or versatility
If software documentation is provided on the software provider's website, then the documentation can be updated, but the documentation becomes disconnected from the software itself requiring additional user time to search
Solution Approach 1:
The patent merges the documentation system with the software application by integrating help information directly into the software interface. Users access documentation through context-sensitive help buttons and menus within the software itself, eliminating the need to separately search websites. The system combines the benefits of online updateability with immediate accessibility within the software environment.
Solution Approach 2:
The patent introduces a database as an intermediary layer between the software and documentation. This database serves as a centralized repository that can be updated independently while providing real-time access to the software application. The mediator enables documentation to be both updateable and seamlessly integrated with the software without requiring direct coupling.
3Reliability
If software providers devote resources to keeping documentation current with evolving software versions, then the documentation can remain accurate, but the resource costs and coordination requirements increase significantly
Solution Approach 1:
The patent implements a self-updating documentation system where end-users directly edit and maintain help information through an integrated interface. This eliminates the need for dedicated technical writer teams and complex coordination between developers and writers. The system automatically manages versioning and updates, reducing organizational complexity while maintaining documentation accuracy through distributed user contributions.
4Adaptability or versatility
If software providers provide documentation only in English, then the documentation can be maintained with fewer resources, but the accessibility to non-English speaking users is limited
Solution Approach 1:
The patent implements a multilingual documentation system where the same database infrastructure supports multiple languages. The system allows different language versions to coexist and be selectively accessed based on user preferences or system configuration. This universal approach enables the documentation to serve diverse linguistic communities without requiring separate maintenance systems for each language, achieving multi-functionality in language support.
Data Source
AI summary
A computer device for modifying software documentation for a software package is provided. A first computer is configured to provide the software documentation including help information related to the software package to a second computer and to receive a command from the second computer that corresponds to providing the help information from the software documentation. The first computer is further configured to transmit the help information from the software documentation in response to the command and to receive an identification from the second computer indicating an identity of the second computer and a request from the second computer to modify the help information within the software documentation. The first computer is further configured to modify the help information within the software documentation in accordance to the request in response to determining that the identity of the second computer is authorized to modify the help information within the software documentation.