43 results about "Software documentation" patented technology

A method of selling custom business software and a software exchange marketplace enables a software seller to offer a custom software application for sale. The method includes receiving the custom software application from the software seller. The marketplace includes a qualified application inventory and a custom software application submission log. A prospective software buyer may search the qualified software application inventory. The method includes associating the custom application with the custom software application submission log. The method identifies deficiencies with a software source code by comparing the software source code to a source code qualification standard. The method identifies deficiencies with a plurality of software documents by comparing them to a document qualification standard. The method compares the submission log with a final review standard. The method qualifies the software source code and software documents before listing them in the qualified software application inventory.

Various embodiments of a system and method for generating software documentation are disclosed. A software documentation generator may input a variety of information sources. In one embodiment, these information sources may include various types of files such as application source code files, tag library files, tag library descriptors (TLD), library source code, web services description language (WSDL) files, configuration files, defect reports, and text files. The software documentation generator may analyze each source to determine its type and use this information to extract documentation data from the source according to the format of the data included in that source. The software documentation generator may reformat the documentation data extracted from each source into a uniform format and aggregate the uniformly formatted data into a uniformly formatted aggregate input document. The software documentation generator may transform this document into one or more sets of software documentation in a specified format.

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.

A method, system, and computer program product for generating a software documentation file from a software source code file is provided. In one embodiment, the source code file for the software is read by the automatic program documentation generation tool. The tool extracts software documentation from the source code file, by for example, locating documentation begin and end indicia within the source code and extracting the data contained within the indicia. The documentation has been previously written into the source code by a software developer, programmer, or engineer. The tool then creates a software documentation file, such as, for example, a UNIX Man Page or an HTML page, from the extracted software documentation extracted from the source code. The software documentation file is typically stored in a central repository.

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 specified help information from the software documentation. The first computer is further configured to transmit the specified 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.

A method executed by a computer under the control of a program includes the step of linking an application program module with a corresponding integrated documentation module. A single window displays an application program module region and an integrated documentation module region in such a manner that the application program module region can be fully viewed. The application program module is compiled without compiling the integrated documentation module. The integrated documentation module region may be turned-off and the application program module region may be re-sized to substantially fill the single window.

Embodiments of the invention provide techniques for providing help content to users of software application, where the help content includes references to interface elements of a graphical user interface. A method for providing help information includes receiving a request for help content, where the requested help content includes a reference to an element of the GUI, determining a current location of an interface element in the GUI corresponding to the reference in the help content, and modifying the help content to specify the current location of the GUI element.

A computer-implementable method and system for managing software code documentation is disclosed. The method receives computer software code and documentation selected by a user and inserts one or more association keys in the selected code and one or more association keys in the selected documentation. The association keys are used to identify a portion of computer software documentation that corresponds with the computer software code. When the user wants to see documentation for a section of code, or code that corresponds to a section of documentation, the user selects the relevant text. The method receives the selected text, retrieves the association keys inserted in the selected text, determines whether the selected text is code or documentation, searches for documentation or code with matching association keys and alters the display of the matching documentation or code.

A method and system for establishing software documentation is provided. Rather than being static, the set of user accessible software documentation for a particular software program could be dynamically updated. The software documentation set accessible by the user may be defined by the configuration state of one or more configuration parameters at any given time. Once the states of the configuration parameters are determined, the program will dynamically update the set of accessible software documentation based at least in part on the configuration states of the configuration parameters. Thus, for any configuration state, only software documentation deemed relevant to the state of the software application could be made accessible to the user, thereby providing a more concise, focused and easily navigable set of software documentation.

The invention discloses a method and a system for positioning a required change influence range during software development. The method comprises the following steps of: inputting at least one required change request, at least one software document and at least one code file set corresponding to the software document; positioning influenced entities in the software document and the code file set according to the required change request; and outputting the influenced entities. By the invention, the required change request can automatically response to and track a code level, so the response of a required change can cover the complete software development flow.

The invention discloses a document generation method and system, equipment and a medium. The method includes extracting a model class contained in the target development software; and if the model class meets the document generation requirement, generating a corresponding development instruction document according to programming codes forming the model class. According to the document generation method provided by the embodiment of the invention, the automatic generation of the software document is realized, the manual generation of the document in the software development project is avoided,the development time is shortened, and the development efficiency is improved.

The invention discloses a method for interconversion between a Chinese office software document and other format documents and a device thereof, and relates to the document conversion, and aim at accelerating the conversion speed between the Chinese office software document and other format documents. The method comprises the following steps: generating an intermediate document according to the format requirements of other format documents / the Chinese office software document; generating an XSL style sheet file according to the intermediate document; and carrying out XSL conversion on the intermediate document by the XSL style sheet file to obtain the other format documents / the Chinese office software document. The device comprises an intermediate document generating unit, an XSL style sheet file generating unit and a conversion unit. The method and the device can accelerate the conversion between the Chinese office software document and the other format documents, and improve the office efficiency.

A problem and a solution to the problem may be described via a language capable of representing structure and relationships. From the problem / solution description, solution-based documentation such as text, figures and code may be programmatically generated.

The invention relates to a mining method and system of core code elements in a software document. The method includes: 1) collecting software documents and source code of to-be-processed software projects, and parsing the software documents and the source code to obtain a candidate document-code relation set; 2) extracting text and code features from the software documents and the software code related to candidate document-code relations, and organizing the features to construct feature vectors of candidate code elements in the software documents; and 3) utilizing the feature vectors of training data with the label core code elements to obtain a classification learning model through optimizing model parameters, and identifying the core code elements in the software document through the classification learning model. The system includes a software document and software code preprocessing module, a feature extraction module and a classification learning algorithm module. According to the method and the system, relations between software documents and software code can be tracked and measured, and core relations and noise relations can be distinguished.

The embodiment of the present application discloses a software document management method, device, and terminal. The method includes: receiving a software document edited by a user, the software document including a UML diagram edited in the form of text, and in the UML Add the front label and the back label respectively before and after the text corresponding to the figure; convert the text between the front label and the back label in the software document into a UML diagram; convert the software document into a preview text, and according to the front label The location of the label and / or post-label inserts the UML diagram into the preview text. With the technical solution provided by the embodiment of the present application, since the UML diagram in the software document is edited in the editing window in the form of text, even if the UML diagram is modified in the source file, the modification mark can be easily seen, Easy to manage software documentation.

The invention discloses a software version state control method, and relates to the technical field of software and information security. The method comprises the following steps: for a given software document, on the one hand, generating a software version state, respectively computing a digital signature file by file, integrally storing the digital signature, the file attributes and a directory path as a derived attendant state file after derivation to represent the software version state, and preserving the an outline identity and an exception file; on the other hand, verifying the software version state, quoting the attendant state file, respectively verifying the digital signatures to identify the integrity consistency of the software document; pre-presenting the outline identity in the process to observer and judge whether to execute the verification, and automatically ignoring and not verifying the exception file; independently comparing the difference between different versions through the adoption of the state file, thereby obtaining a comparison report. A general method is provided by the invention, a derived attendant software state file is used for representing and verifying the version state of the software document, the derived attendant software state file can be used as the authentication credential about the business collaboration of development and research, evaluation, testing, supervision and publish, thereby achieving the aim of effectively controlling the software version.

A method for customizing end-user or administrative software documentation such as installation instructions is provided. A software provider first collects computer system information for multiple computer sub-systems used by a customer. The collected computer system information comprises sub-system descriptions of each of the multiple computer sub-systems, software descriptions of all software that is currently residing in each of the multiple computer sub-systems, and hardware descriptions of all hardware that are allocated to each of the multiple computer sub-systems. The software provider then receives, from the customer, the name of new software that is to be installed in a user-selected computer sub-system. Based on the collected computer system information, the software provider determines which specific device in the user-selected computer sub-system should have the new software installed. At run time, variables in the installation instructions are replaced with a device's name.

A remote control system of a home network, for remotely managing an information terminal installed in the home network, includes: an authentication module, which authenticates an information terminal by receiving authentication information when the information terminals connected through the network, stores the authenticated information in a database, and supplies common home network information to each information terminal; a software upgrading module, which selectively or completely installs the software documentation, or upgrads the version of the software documentation, in the information terminal that the authentication module authenticates through the network; a monitoring module, which monitors whether the normal operations of the software documentation installed by the software upgrading module and the information terminal handling the software documentation, and generates an alarm signal when abnormality occurs in the software documentation or at the information terminals; a statistical module, which generates statistical business information about upgrading of the software upgrading module to the software documentation at the information terminals, or statistical distribution information about the distribution of the information terminals, and supplies the statistical business and distribution information to the system administrator at the requirements of the system administrator.

An embodiment of the invention produces software documentation that includes first and second sections. Skills a technical writer needs are determined, wherein preparation of the first and second sections require different skill sets. A database is searched to select technical writers qualified to prepare each of the multiple document sections, wherein the database contains the identities and qualifications of persons qualified to be technical writers. Preparation of the first and second sections are then assigned to first and second writers having first and second skill sets, respectively. Each prepared section is validated for incorporation into the software documentation.

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.

The invention discloses a QT5 software-based document automatic generation method and generation device for demand specification description documents. The method comprises the following steps of 1, designing an editing interface based on QT5 software; 2, inputting a demand label into the editing interface, and inputting corresponding demand content into the corresponding demand label; 3, using the QT5 software for controlling Office software to automatically generate the demand specification description documents meeting requirements. The invention has the advantages that the thought of demand developers is released, the demand developers do not need to care about document standards and format problems and only need to focus on demand development content, software document content meetingtemplates or standards can be generated in a one-key mode, and the software development efficiency is greatly improved.

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.