WO2002017126A2 - Apparatus and method for the compilation, assembly, and distribution of product documentation and associated information - Google Patents
Apparatus and method for the compilation, assembly, and distribution of product documentation and associated information Download PDFInfo
- Publication number
- WO2002017126A2 WO2002017126A2 PCT/CA2001/001194 CA0101194W WO0217126A2 WO 2002017126 A2 WO2002017126 A2 WO 2002017126A2 CA 0101194 W CA0101194 W CA 0101194W WO 0217126 A2 WO0217126 A2 WO 0217126A2
- Authority
- WO
- WIPO (PCT)
- Prior art keywords
- document
- component part
- information
- part information
- sgml
- Prior art date
Links
Classifications
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F40/00—Handling natural language data
- G06F40/10—Text processing
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F40/00—Handling natural language data
- G06F40/10—Text processing
- G06F40/166—Editing, e.g. inserting or deleting
- G06F40/174—Form filling; Merging
Definitions
- TITLE APPARATUS AND METHOD FOR THE COMPILATION, ASSEMBLY, AND DISTRIBUTION OF PRODUCT DOCUMENTATION AND ASSOCIATED INFORMATION
- the present invention generally relates to an apparatus and method for the collection, assembly, editing, and publication of information from a . variety of independent sources. More specifically, the present invention concerns the compilation, assembly, publication, distribution and use of electronic information of a variety of types, including electronic manuals and product documentation.
- the documentation may encompass ⁇ i broad spectrum of information, most commonly including technical manuals that describe the product in detail and instruction manuals for operating the product (when required) .
- the booklets may encompass a technical manual (or several manuals) describing the automobile and the equipment that accompanies it, an instruction booklet for the operation of the automobile and associated equipment, and possibly a booklet to assist in tracking the maintenance schedule for the vehicle.
- the same type of documentation is provided whenever a manufacturer sells any complex product, such as a train locomotive or an airplane.
- the product literature that accompanies the product is usually much more extensive than that provided with an automobile .
- the assembly of the documentation for these large- scale engineering projects is often expensive.
- the printed version of the product literature alone may encompass thousands of pages and incorporate product information from multiple vendors. Compiling, formatting, editing, and printing this information is often a time consuming and labor intensive task. For certain projects, the task may typically consume thousands of man-hours.
- Product literature for complex products may encompass a broad spectrum of documentation relating to topics such as the operation, repair, and maintenance of the product and the supporting infrastructure.
- the product literature generally includes a technical description, with one or more related drawings, of each part in the railway system. Additionally, because various parts in the system are manufactured and maintained by more than one vendor, specifications from each vendor must be independently obtained and incorporated into the final manual in order to create a useful and effective informational tool for the customer.
- the party responsible for producing the product documentation i.e., the manufacturer
- the manufacturer must also organize the individual parts descriptions and assemble the descriptions into a final document that presents the information in an easily accessible format for the customer.
- the assembly of the information received from vendors is even more complex when the information is provided in an electronic form, because each of the various vendors may use different formatting and presentation standards for the information that they supply. This complicates the task of assembling a final unified document, because the different information formats must be accommodated before the final documentation may be assembled.
- the present invention addresses the needs that have developed for the generation and distribution of product literature, documentation and information, including technical manuals.
- systems and methods consistent with the principles of the present invention address the needs identified above by providing an improved system for gathering, assembling and distributing product literature, documentation and information, such as technical manuals.
- the present invention it is an object to provide a method of compiling, assembling and distributing a technical document relating to a project.
- the method includes receiving component part information describing information for the technical document, from a plurality of vendors, where each of the vendors is responsible for documenting a portion of the project.
- the received component part information is stored at a central location.
- at least a portion of the technical document is generated by retrieving and organizing elements of the stored component part information.
- the retrieving and organizing operations are based on a file describing the desired structure of the technical document.
- the technical document is distributed to the customer.
- the method further includes, prior to the receiving of component part information, guiding the preparation of component part information by the vendors.
- preparation of the component part information is effected by a guided authoring tool implemented on a computing platform, which guides the preparation of the component part information on a basis of a structured document model file.
- the latter defines at least in part a structural layout of text in the component part information.
- the respective component part information submitted by each of the plurality of vendors conforms to the common structured document model file.
- the method also includes validating the component part information submitted by each of the vendors, as well as preventing the vendors from modifying the structured document model file.
- the validation of the component part information includes verifying that the component part information submitted does in fact conform to the predefined structured document model file.
- the predefined structured document model file is a Document Type Definition (DTD) of the SGML (Standard Generalized Markup Language) format.
- DTD Document Type Definition
- SGML Standard Generalized Markup Language
- each of the plurality of vendors is associated with a user profile defining the vendor access rights. Accordingly, the method further includes the step of authorizing a particular vendor to submit component part information at least in part on a basis of the user profile associated with the particular vendor. Thus, a particular vendor is restricted from submitting new component part information or maintaining previously stored component part information that is not relevant to the particular project for which the particular vendor is responsible.
- It is another object of the present invention to provide a document center which includes a data acquisition component configured to receive, from a plurality of vendors, component part information describing information relating to a project. Each vendor is responsible for documenting a portion of the project.
- a component part repository is coupled to the data acquisition component and stores the received component part information.
- a publication engine is coupled to the component part repository for automatically generating at least a portion of a technical document describing the project by retrieving and organizing elements in the component part repository. The retrieval and organization of the document is based on a file describing the desired structure of the technical document.
- a distribution component is provided for distributing the structured electronic document to a customer.
- the document center includes an editor coupled to the component part repository. This editor allows operators of the document center to modify the stored component part information in the component part repository.
- the data acquisition component of the document center includes a guided authoring module.
- This guided authoring module is operative to guide each of the vendors in the preparation of the component part information for submission to the document center, on a basis of a structured document model file, such as an SGML DTD.
- the data acquisition component is operative to prevent any one of the vendors from modifying the structured document model file, such that all the component part information received from each vendor is prepared on the basis of a common structured document model file.
- the data acquisition component includes a validator module for validating the component part information submitted by the vendors.
- This validator module verifies that the component part information conforms to the predefined structured document model file, and verifies the nomenclature and coherency of the text in the component part information.
- the method includes storing a plurality of Standard Generalized Markup Language (SGML) files, where each of the files relates to at least one aspect of the engineering project.
- the method further includes assembling information from select ones of the plurality of SGML files into the technical manual based on pre-defined files describing the desired structure and content of the technical manual.
- the SGML files include information describing at least one of parts used in the engineering product or maintenance schedules relating to the described parts.
- Fig. 1 is a block diagram of an exemplary network on which product documentation (such as an electronic manual) can be compiled, assembled and distributed consistent with the teachings of the present invention
- Fig. 2 is a high-level flow chart illustrating the creation and distribution of the product documentation (i.e., the electronic manual) ;
- Fig. 3 is block diagram illustrating an exemplary implementation of the document center
- Fig. 4 is a diagram illustrating the functional components of the data acquisition source component of the document center
- Fig. 5 is a diagram illustrating the functional sections of the equipment list maintenance component
- Fig. 6 is a diagram illustrating the main functional aspects of the vendor information blocks environment component
- Fig. 7 is a diagram summarizing the types of information that may be exchanged between the components in a system consistent with the present invention.
- Fig. 8 is a flow diagram illustrating exemplary processes consistent with the present invention.
- Fig. 9 is a high-level diagram illustrating the integration of various business divisions with vendors and customers.
- Fig. 10 is a high-level diagram illustrating interaction of outside parties with a system including the document center. DETAILED DESCRIPTION
- the product documentation is generated in a highly automatic manner from a component part repository.
- Information blocks in the component part repository such as information relating to a particular part in an engineering design, are stored instances of a common data model.
- the electronic manual can be quickly and efficiently generated from the information blocks using scripting programs and document definition files designed to define the layout of the electronic manual.
- the tools used to create the electronic manual are highly re-useable and adaptable, allowing new manuals for new customers to be created quickly and efficiently.
- the product documentation may be provided as an interactive electronic manual (IEM) , standardized interchange formats (e.g., in the case of a railway product, EPCES from the Rail Industry Forum (RIF) ) , a printed document, a database input, or outputs to databases, to name a few examples encompassed by the present invention.
- IEM interactive electronic manual
- RIF Rail Industry Forum
- Fig. 1 is a block diagram of an exemplary network on which the electronic manual consistent with the present invention can be assembled and distributed.
- Document center 110 is a collection of programs, methods, tools, networks and computers that help to generate and manage the electronic manual. Document center 110 involves the interaction of methods, interfaces, procedures, transformation programs and software for its operation. Document center 110 is implemented within or by the company or organization that is taking the lead role in the production of the electronic manual (i.e., the manufacturer of a product) . Typically, document center 110 may be maintained by a technical publication and/or information services department of the company or organization.
- Document center 110 can communicate with vendors 101- 102 and customer 104 via network 112.
- Network 112 may be, for example, the Internet.
- each one of a plurality of vendors 101-102 is responsible for a portion of the electronic manual. While reference is made to only two vendors herein, those skilled in the art will readily recognize that the number of vendors 101-102 may be far greater than two.
- each of vendors 101-102 may be responsible for a particular portion of the project and for the documentation corresponding to their portion.
- the final technical manual is to be delivered to customer 104 by the organization implementing document center 110.
- Fig. 2 is a high-level flow chart illustrating creation and distribution of an electronic manual.
- Documentation relating to each portion of the project is collected in a component part repository at document center 110. More specifically, vendors 101-102 submit part information and maintenance information to document center 110 via network 112 (act 201) . Document center 110 may itself generate and submit information relating to the project, or edit previously submitted information (act 202) . More particularly, document center 110 can enrich the existing information by, for example, adding hyperlinks, navigational information and hotspot information ( e . g. to graphics). Document center 110 may also link specific information (i.e., the hotspots) to other information, such as related text or parts lists.
- specific information i.e., the hotspots
- document center 110 tracks and manages changes in the various versions of the product information and prepares the information for a specific output format (e.g., paper, IEM, EPCES, etc.). Media-specific information may also be added by document center 110, depending on the output format. For example, document center 110 may add a table of contents, page information, page breaks, a table of contents for hyperlinks, search indices and navigational information, among others. Additionally, the end customer may contribute to the electronic document (act 203) . The customer may, for example, submit information such as customer part numbers or submit feedback or additions to a current version of the electronic manual .
- a specific output format e.g., paper, IEM, EPCES, etc.
- Media-specific information may also be added by document center 110, depending on the output format. For example, document center 110 may add a table of contents, page information, page breaks, a table of contents for hyperlinks, search indices and navigational information, among others.
- the end customer may contribute to the electronic document (act 203) .
- the document center 110 is operative to guide any submission of information during acts 201-203, such that the information submitted is in the form of a predefined structured document model, common to submission by vendor, customer or document center 100. All of the information submitted during acts 201-203 is stored in an information component repository
- act 204 the information blocks in the component repository containing tags that describe the content of the information blocks.
- the tags are applied pursuant to the predefined structured document model, as will be described in further detail below.
- An example of such a structured document model is an SGML (Standard Generalized Markup Language) Document Type Definition (DTD) .
- the operators at the document center 110 assemble the manual with the help of scripts and data files that are defined to generate the desired formatting and organization of the manual (act 205).
- the final manual can be printed or made available electronically to customer 104.
- Fig. 3 is block diagram illustrating an exemplary implementation of document center 110.
- Vendors 101 and 102 interface with document center
- DAS 320 is a web application through which vendors 101-102 submit data related to their portion of the engineering project to the document center 110.
- DAS 320 presents an electronic environment that assists vendors in writing, assembling, verifying, and submitting the required material.
- Web server 301 is a computer server, or network of computer servers, executing a web serving program, such as an EDMS (electronic data management system) program.
- Web serving programs are well known in the computer art.
- Computer servers equipped with web serving programs are commercially available from a number of companies, such as the "Domino" family of server programs, available from Lotus Corporation.
- One of the features of the web serving program executed by the web server 301 is a security mechanism operative to ensure a secure electronic environment and to authenticate system users.
- a security mechanism includes a 40 or 128-bit encryption/decryption scheme as well as intrusion detection capability.
- vendors are pre-certified by document center 110 as being authorized vendors, each pre- certified vendor being associated with an exclusive system account and a respective user name and password.
- a vendor is prompted by the web server 301 interface to provide a user name as well as a password.
- the security mechanism implemented by the web serving program is operative to attempt to authenticate the vendor on a basis of the user name and password provided upon log-in. If the vendor is authenticated by the security mechanism, the log-in process is completed. Alternatively, the log-in process is aborted and the vendor is refused access to the document center 110, due to an invalid vendor identification.
- Each pre-certified vendor is also associated with a particular user profile defining the access rights of the vendor.
- various levels of control are available to the vendors with regard to the authoring of material and release of information to the DAS 320.
- each user account is associated with one of three possible levels of control, notably Read-only, Edit or Release.
- a user profile defining "Read-only” access rights permits the vendor to read and print data stored in the document center 110.
- a user profile defining "Edit” access rights permits the vendor to author new information and to modify information already stored in the document center 110.
- a user profile defining "Release” access rights permits the vendor to release information submitted to the document center 110 for use by the document center 110 in assembling the manual.
- the user profile defines a specific subset of information to which the vendor has access, thus restricting the access rights of the vendor.
- a particular vendor is responsible for a certain set of parts.
- the vendor is authorized by the security mechanism to only input or manipulate documentation directed to the certain set of parts, on a basis of the predefined user profile associated with the particular vendor' s account.
- the action will be refused by the security mechanism of the web serving program and an "Access Denied" message will be transmitted to the vendor.
- Documentation received from vendors 101-102 is stored in component part repository 304. Additional documentation may be added, adjusted, edited, or generated internally to document center 110. This is illustrated by the component 303 in Fig. 3, labeled "Internally Created Content.”
- Editor 305 accesses the information in component part repository 304. Through editor 305, information in component part repository 304 can be viewed and edited by the document center 110. In practice, technical writers or other staff members at document center 110 often edit or add to the information in component part repository 304.
- the editor 305 is an SGML-based editor, such as the "FrameMaker + SGML" software package available from Adobe Corporation of San Jose, California.
- Publication engine 306 generates customized technical manuals or other documents from the information stored in component part repository 304.
- the order of the information components in the generated manual and a description of the presentation of the components is specified by a master document file (or files) that is read by assembly scripts 307 and input to publication engine 306.
- publication engine 306 executes scripts that perform basic document assembly operations, such as compiling a document from its component parts and indexing the compiled document to generate an index.
- the intended organization of the component parts is read by the scripts from the master document file, which is prepared by operators at document center 110.
- Publication engine 306 may additionally apply styles to refine the presentation style (e.g., fonts, etc.) of the manual.
- the generation of the electronic manual is largely automated, the manual can also be viewed, verified, or refined by human operators .
- manuals generated by publication engine 306 may be simultaneously distributed to customer 104 in a variety of formats (e.g., printed, on CD-ROM, electronically via network 112, etc.).
- Distribution component 308, which is described in more detail below, enables distribution of the manual to customer 104.
- Fig. 4 is a diagram illustrating the functional components of the DAS component 320.
- DAS component 320 provides a web-based environment in which vendors 101-102 can interact and enter their part data. Vendors visiting DAS component 320 are initially presented with a web page, shown as homepage 401. Through homepage 401, vendors may logon and authenticate themselves to web server 301. The homepage 401 also posts messages intended for the vendors/authors.
- the homepage 401 is the access point for several on-line services, such as a
- Vendor Work Instructions (VWI) manual a legal disclaimer, an on-line help tool and all system Access Request forms.
- the VWI manual and the Access Request forms are stored as downloadable documents, for example .pdf documents, that can be downloaded to the vendor's workstation.
- downloadable documents for example .pdf documents
- a technician-manned Help Desk may exist as an additional source of aide to the system users.
- the Help Desk specifically caters to vendors for quick answers to common user problems.
- the homepage 401 also contains phone and fax numbers to the Help Desk, as well as e-mail coordinates.
- ELMS component 402 allows vendors to enter basic information pertaining to their parts lists.
- ELMS component 402 information concerning maintenance, such as tasks relating to required tools, job-skills and training, is entered.
- ELMS component 402 forms the backbone of the system by controlling the parts database and the list of the maintenance procedures associated to each maintainable part.
- VIBE component 403 allows vendors to enter the detailed textual and graphical information that describes parts provided by each particular vendor.
- Vendors use ELMS component 402 to perform three main functions: (1) identify parts; (2) identify operations on main tainable parts and the relationship between the maintainable parts and any related maintenance tasks; and (3) identify parts that are replaceable parts.
- a maintainable part is a part that requires maintenance.
- a replaceable part in contrast, refers to a part that has to be replaced, bought, and stocked in inventory.
- ELMS component 402 may be implemented as a Java applet transmitted, on request, to vendors 101-102.
- the ELMS Java applet runs on the vendor's computer and transmits information entered by the vendor back to document center 110.
- a windows-like interface is provided by the ELMS component 402 to the vendor, permitting easy data entry and a user-friendly parts assembling environment.
- ELMS component 402 is capable to perform standard on- the-fly validation of the information submitted by a vendor, in order to prevent duplication of data and other such mistakes.
- standard on-the-fly validation functionality is well known to those skilled in the art, being common to most word processing software, and as such will not be described in further detail.
- Fig. 5 is a diagram illustrating the three main functional sections of ELMS component 402: parts module 503, parts maintenance tree (PMT) module 504, and figure tree (FT) module 505.
- Vendors input to parts module 503 lists of parts for which they are responsible. The list may include, for example, parts used in the final engineering design and parts used as special tools or test equipment in the design.
- the list of parts input to parts component 503 is not structured; rather, it is a flat list of parts for a particular vendor.
- a vendor may input parts one by one to the parts module 503, or may initiate a batch upload of parts to the parts module 503 from an existing file, via an import module of the ELMS component 402.
- the import module provides an interface to the vendor that prompts the vendor for information relating to the file to be imported, such as its file name and location. Possible locations for the file include the hard and floppy drives of the vendor' s computer, as well as a server drive to which the vendor's computer may be connected via a data network.
- a vendor may initiate a batch download of parts from the parts module 503 to a local file, via an export module of the ELMS component 402.
- Each part input by the vendor is uniquely identified by a part number. Additional information may be input for each part, such as a description of the part, vendor or builder part numbers or codes, and whether the part is commercially available on the open market.
- Parts module 503 shown in Figure 5 contains an exemplary list of vendor entered parts, including HVAC unit 510, heater 511, motor 512, circuit breaker 513 and air conditioner 514.
- Parts listed in the parts module 503 are assembled in the PMT module 504 using a maintenance-based hierarchy. More specifically, in the PMT module 504, vendors define maintenance requirements for the parts in their part list(s). The same part, in different structural locations, may require different maintenance procedures due to, for example, different access procedures or more stringent use. Thus, maintainable items in PMT module 504 are organized in a hierarchical manner based on the relationship of a particular part to its structural location in a larger component and its maintenance requirements, where the maintenance structure is created based on the list of parts in the parts module 503.
- the maintenance structure for HVAC unit 510 includes heater component 511 and air conditioner component 514.
- Each of heater 511 and air conditioner 514 are further defined by a motor 512 and a circuit breaker 513.
- Each instance of the components 510-514 in the PMT module 504 is linked to the primary description of the part in the part list and is associated with maintenance related information specific to that instance of the part.
- the maintenance related information may include, for example: a maintenance ID number permitting tracking and validation of the part, expected service life, time required to inspect, and the mean time to repair, among other possibilities. Alternatively, if the part is a replaceable item, this fact is entered in the description.
- the figure tree module 505 is where the parts are assembled using a parts catalog-based hierarchy. More specifically, FT module 505 illustrates a hierarchical list of replaceable parts, replaceable assemblies, and replaceable sub- assemblies and links them to an illustration file. As with the PMT module 504, entries in the FT module 505 are arranged hierarchically based on the components in the parts list. By linking illustrations hierarchically, end user's can "drill down" into an illustration to obtain more detailed information about a specific portion of the illustration. In sum, vendors use FT module 505 to define the relationship between illustrations of parts. Actual creation of and entry of the illustrations, however, is accomplished with VIBE component 403.
- the structure of the figure tree follows a functional system-by-system breakdown, down to the lowest-level replaceable assembly. Next, the component and sub-component items are added, down to the lowest replaceable component.
- Each illustration in the figure tree is associated with a vendor figure number, an illustration file name and a figure title.
- a vendor may add, modify and delete figure records, as well as enter reference information for illustration files. Further, a vendor may add, modify, delete and indent figure assemblies, components and items, as well as import and export figures .
- parts in the parts module 503, PMT module 504 and FT module 505 are internally linked, such that changing a characteristic of a part in one of components 503-505 correspondingly affects instances of the part in the other of the components 503-505.
- text related to an illustration may be linked to the illustration.
- the textual information relating to a part may include tags identifying an illustration, or a component in an illustration.
- illustrations can contain tags identifying textual information related to the illustration. This allows publication engine 306 to generate electronic manuals with hyperlinks allowing users to jump between the textual description and the graphical illustration for a part.
- Fig. 6 is a diagram illustrating the main functional aspects of VIBE component 403, which includes two modules: a web interface module 603 for the management of information blocks and a validator module 607.
- VIBE component 403 provides vendors with guided document management authoring tools that allow vendors 101-102 to enter substantive part information in a format consistent for all vendors.
- ELMS component 402 through which vendors enter basic part information and information directed to the relationships between parts, VIBE component 403 allows the vendors to create the detailed textual and graphical information describing the parts.
- each of the participating vendors creates their documentation using a guided authoring module.
- a local instance of the guided authoring module 601 is installed at each of vendors 101-102, including a set of templates 605.
- Information entered at vendors 101-102 via the authoring module 601 is uploaded to web server 301 of document center 110.
- the guided authoring module 601 guides the vendor throughout the entire process of creating, editing, submitting and revising of documentation, on the basis of a structured document model file describing the structure of the documentation, including the text layout of the documentation.
- the guided authoring module 601 ensures that the information submitted by the vendor conforms to this predefined structured document model file.
- the guided authoring module 601 guides the vendor by strictly limiting the operations performed by the vendor to insertions of valid elements into the document being created, edited or revised. Thus, the burden of formatting the authored information is removed from the vendor, and performed entirely by the guided authoring module 601.
- the setup of the guided authoring module 601 is inaccessible to the vendor, such that the vendor is restricted from modifying in any way the predefined structured document model file, and thus the guidelines provided by the guided authoring module 601.
- all information submitted to the DAS 320 by vendors conforms to the predefined structured document model file as enforced by the guided authoring module 601.
- the guided authoring module 601 allows a vendor to create information blocks describing the parts for which that vendor is responsible.
- Each information block entered by a vendor is associated with an identification number that links the block to the parts list entered previously by the vendor via the ELMS component 402.
- the vendor uploads the information blocks, including the identification number, to the web server 301.
- the information blocks submitted by a vendor can include audio or video files, as well as standard text and graphics.
- an information block can include SGML text, CGM4 illustrations, 3-D graphics, etc.
- the modules 603 and 607 thus provide for the validation of information submitted to the DAS 320 by the vendor, via the guided authoring module 601 of the VIBE component 403, ensuring that this information is electronically and structurally valid.
- the guided authoring module 601 is implemented using a customized version of the "FrameMaker + SGML" software package, available from Adobe Corporation.
- the "FrameMaker + SGML” application allows templates 605 to be used to create documents having a highly structured composition.
- a Software Developer's Kit also available from Adobe Corporation, is used to customize the standard "FrameMaker + SGML” software in order to configure it to the needs of the DAS 320. It is important to note that other markup description languages, such as XML (extensible markup language) , could be used in place of SGML.
- Descriptive markup describes the semantic nature of the text in a document, rather than its physical appearance on the page. Descriptive markup is based on the structure of a document and identifies elements within that structure — such as a chapter, a section, an abstract, or a table — using notations that describe what the element is, and not how it appears.
- SGML also specifies a standard method for describing the structure of a document. In other words, SGML allows the user to set up hierarchical models for each type of document produced.
- SGML forces each element in the structure, which is labeled with a descriptive markup tag, to fit in the logical structure of the document.
- DTD Document Type Definition
- a DTD also specifies rules for the relationships between elements, such as "a chapter heading must be the first element after the start of a chapter” or "each list must contain at least two items.” These rules, which the DTD defines, help ensure that documents have a consistent, logical structure.
- a DTD accompanies a document wherever it goes.
- the content of a document includes titles, paragraphs, lists, tables, graphics and audio.
- the method for identifying the content's position within the DTD structure is called "tagging" .
- Creating an SGML document involves inserting tags around content. These tags mark the beginning and end of each part of the structure.
- authoring configuration files are installed on each vendor workstation 101, 102. These authoring configuration files customize the "FrameMaker + SGML” application such that the interface appearing to the vendor is a minimal one that guides the authoring process, thus promoting efficiency. More specifically, the authoring configuration files ensure that certain standard tools/dialogs permitting modification of the DTD are removed from the "FrameMaker + SGML” application, such that they are unavailable to the vendor. The vendor thus has no choice but to be guided by the customized "FrameMaker + SGML" application in order to author a document, possibility of control over the software application by the vendor having been removed by the authoring configuration files.
- the templates 605 of the customized "FrameMaker + SGML" application are designed based on an SGML DTD provided by document center 110, as selected by the product manufacturer.
- the resultant data entered by the vendor is thus output in SGML format according to this same selected DTD.
- the templates 605 downloaded from document center 110 to the vendor workstations 101, 102 may be additionally customized for each vendor, such that the guided authoring module 601 contains narratives related to the information for which a particular vendor is responsible .
- the validator module 607 of VIBE component 403 is operative to verify, for each information block submitted by a vendor to the DAS 320 via the guided authoring module 601, certain criteria, such as: • Validity of the SGML structure as compared to the predefined DTD. In other words, the validator module 607 checks to make sure that the information block is properly configured and that the appropriate DTD was used by the vendor 101 in creating the information block. In a specific example, when an information block is created and submitted by a vendor to the DAS 320 using the appropriate DTD, the guided authoring module 601 stamps the information block with a predetermined identifier, confirming a valid configuration for the information block. The validator module 607 thus searches the submitted information block for the presence of this predetermined identifier, in order to validate the information block.
- certain criteria such as: • Validity of the SGML structure as compared to the predefined DTD.
- the validator module 607 checks to make sure that the information block is properly configured and that the appropriate DTD was used by the vendor
- the validator module 607 checks the information block content to verify the structural layout of parts, the part numbers, the part number tags and the existence of part(s) in the PMT module 504, among other possibilities. In order to do so, the validator module 607 is operative to compare the data in the information block against the list of parts previously downloaded to the system via the ELMS component 402, with reference to the existing contents of the parts module 503, the PMT module 504 and the FT module 505.
- the validator module 607 checks the validity of any references to maintenance procedures contained within the information block, by consulting the vendor-defined part maintenance requirements defined in the PMT module 504. It is possible that a reference to a maintenance procedure in the information block is in contradiction with previously defined maintenance-related information stored in the PMT module 504.
- Presence of a release number letter Upon submission of data to the DAS 320 by a vendor, the data must be assigned a release letter number, for tracking purposes.
- the vendor is prompted by the guided authoring module 601 to assign a release number to an information block that has been prepared for submission to the DAS 320.
- the validator module 607 thus searches the submitted information block for the presence of a release letter number, in order to validate the information block.
- the validator module 607 may be operative to verify many other possible criteria, without departing from the scope of the present invention.
- the validator module 607 may determine that the information block submitted by a vendor is invalid, for example if the information block is not stamped with the predetermined identifier or if there is a lack of coherence with the PMT module 504. In such a situation, the validator module 607 is operative to refuse the invalid data and to return this invalid data to the vendor with a "Data Invalid" error message.
- DAS component 320 of document center 110 allows vendors to easily submit and maintain documentation relevant to a portion of a project for which they are responsible.
- the component information is generated as SGML files having a document type definition (DTD) designed to store the types of data required for the particular project.
- DTD document type definition
- the SGML component files from vendors 101-102 are stored in the component part repository 304. Through editor 305, the SGML components in repository 304 can be viewed and edited. SGML editors are well known and are commercially available. One appropriate SGML editor is available in the "FrameMaker + SGML" software package, available from Adobe Corporation.
- SGML SGML
- component part repository 304 By storing all of the information required for a technical manual as SGML components in component part repository 304, a complete technical manual can be quickly and easy assembled. Since SGML divides data objects into discrete elements of information based on the content of the information, the components can be efficiently re-used and modified. Further, different manuals, targeted for different audiences or arranged for different purposes, can be generated based on the same information in component part repository 304.
- publishing engine 306 assembles the SGML components in the component part repository 304 to obtain a complete technical document.
- the final document may then be output to the customer via distribution component 308, which is a multi-channel publisher capable of producing the final document as either an on-line manual, a printed manual, an electronic manual stored on CD-ROM, or an interactive electronic manual, among other possibilities.
- distribution component 308 is a multi-channel publisher capable of producing the final document as either an on-line manual, a printed manual, an electronic manual stored on CD-ROM, or an interactive electronic manual, among other possibilities.
- the sub-components are not limited to those listed and may include a web server, among others.
- Each of sub-components 315-317 handles final formatting for distribution in its respective medium.
- Distribution component 308 may include a web server from which customer 104 requests portions of the electronic manual.
- Suitable applications for electronically publishing an electronic document are known in the art.
- One suitable publishing application is "Insight" by Enigma Software Corporation, of Burlington, Massachusetts. Insight creates a document database that can be translated dynamically to customer 104 as a combination of HTML, Java, and ActiveX programs. The database can be electronically searched by keyword, thus making the electronic manual more interactive.
- Fig. 7 is a diagram summarizing the information exchange between the components in a system consistent with the present invention. As shown, both vendors 101-102 and customers 104 communicate with the document center 110.
- the vendors 101-102 and the document center 110 typically communicate information such as: technical descriptions, engineering drawings, engineering change notices, project documents, approval notices, comments, annotations, and parts lists.
- customers 104 and the document center 110 typically communicate information such as: project documents, approval notices, engineering change notices, engineering drawings, as-build product configurations, training manuals, comments and annotations to the technical manuals, warranty claims, and part lists.
- Fig. 8 is a flow diagram illustrating exemplary processes consistent with the present invention.
- Fig. 8 illustrates exemplary processes performed at the vendor site 101-102, at the document center 110, and at the customer 104.
- the vendor manages the creation and editing of the vendor part list, the part maintenance tree and the figure tree, strictly guided by the guided authoring module 601 of the document center 110.
- the portions of a project that the vendor 101-102 is responsible for are described by a contractual data requirement list.
- Validation refers to the process of ensuring that information received is characterized by a valid SGML structure as compared to the predefined DTD. Validation also involves ensuring that the SGML files received from the vendor 101-102 are internally consistent (i.e., the parts are described appropriately), as well as consistent in a global context. Global consistency refers to, for example, checking that parts are described with consistent terminology and that the version of a part description matches the version of the illustration.
- GMLP Global master list parts flat list of all maintenance items in project
- VDCN Vendor data change notice.
- Fig. 9 is a high-level diagram illustrating an additional embodiment consistent with the present invention.
- the document center 110 is extended to interact more fully with the internal business processes/divisions of the company hosting the document center 110.
- the extended document center is referred to as the integrated information exchange manager (HEM) 901.
- HEM integrated information exchange manager
- HEM links vendors 902, customers 903, and the internal business processes/divisions 904-908.
- the engineering division 905 after creating the Document Type Definitions (DTDs) and other technical specifications for one or more projects, can directly forward the DTDs to the HEM 901.
- Customer orders entered from an electronic parts catalog may be directly forwarded to the purchasing division 904.
- the technical publications division 906, customer services division 907, and project management division 908 are all linked, via HEM 901, to each other and to the vendors 902 and customers 903.
- Internal databases and business systems such as enterprise resource planning (ERP) system 910, product data management (PDM) system 911, and component management system (CMS) 912, may also be linked through HEM 901.
- ERP enterprise resource planning
- PDM product data management
- CMS component management system
- Fig. 10 is a diagram illustrating high-level interaction of customers, vendors, and other parties with the company hosting the HEM 901.
- web portal 1001 suppliers, partners, and customers may interact with ERP system 910 and PDM system 911. Vendors and other e-commerce partners directly interact with the hosting company through HEM 901.
- the above described systems and methods are capable of generating manuals including constituent components from multiple parties.
- the above described system is highly efficient, as it is largely automated and allows for data reuse when generating updated versions of a manual or when generating a second manual that uses some or part of the information in the first manual.
- the data control structures such as the assembly scripts, master document files, and style sheets can often be re-used across different data sets.
- each vendor 101-102 is responsible for a separate component, several vendors may supply information blocks for those components separately without concern for the integration of their particular blocks with those of other vendors.
- several vendors may provide information blocks in parallel. This differs from the past where vendors typically provided information in serial order because they were charged with responsibility for assuring continuity. Since the vendors may supply information blocks in parallel, the product documentation may be assembled much more rapidly than in the prior art.
Abstract
Description
Claims
Priority Applications (3)
Application Number | Priority Date | Filing Date | Title |
---|---|---|---|
CA002420009A CA2420009A1 (en) | 2000-08-18 | 2001-08-20 | Apparatus and method for the compilation, assembly, and distribution of product documentation and associated information |
EP01966869A EP1311976A2 (en) | 2000-08-18 | 2001-08-20 | Apparatus and method for the compilation, assembly and distribution of product documentation and associated information |
US10/344,940 US20040220815A1 (en) | 2000-08-18 | 2001-08-20 | Apparatus and method for the compilation, assembly, and distribution of product documentation and associated information |
Applications Claiming Priority (8)
Application Number | Priority Date | Filing Date | Title |
---|---|---|---|
US22609600P | 2000-08-18 | 2000-08-18 | |
US60/226,096 | 2000-08-18 | ||
US64549100A | 2000-08-25 | 2000-08-25 | |
US09/645,491 | 2000-08-25 | ||
USPCT/CA01/00403 | 2001-03-28 | ||
CA0100403 | 2001-03-28 | ||
US29727101P | 2001-06-12 | 2001-06-12 | |
US60/297,271 | 2001-06-12 |
Publications (2)
Publication Number | Publication Date |
---|---|
WO2002017126A2 true WO2002017126A2 (en) | 2002-02-28 |
WO2002017126A3 WO2002017126A3 (en) | 2002-09-26 |
Family
ID=27426778
Family Applications (1)
Application Number | Title | Priority Date | Filing Date |
---|---|---|---|
PCT/CA2001/001194 WO2002017126A2 (en) | 2000-08-18 | 2001-08-20 | Apparatus and method for the compilation, assembly, and distribution of product documentation and associated information |
Country Status (2)
Country | Link |
---|---|
EP (1) | EP1311976A2 (en) |
WO (1) | WO2002017126A2 (en) |
Cited By (3)
Publication number | Priority date | Publication date | Assignee | Title |
---|---|---|---|---|
GB2404270A (en) * | 2003-07-24 | 2005-01-26 | Hewlett Packard Development Co | Document composition |
EP1535129A2 (en) * | 2002-08-02 | 2005-06-01 | NRX Global SRL | Equipment documentation management system, method, and software tools |
EP1883011A1 (en) * | 2006-07-21 | 2008-01-30 | Software Ag | System and methods for generating runtime messages |
Citations (2)
Publication number | Priority date | Publication date | Assignee | Title |
---|---|---|---|---|
US5228121A (en) * | 1989-09-29 | 1993-07-13 | Digital Equipment Corporation | Document generation using information engineering |
US5457792A (en) * | 1991-11-07 | 1995-10-10 | Hughes Aircraft Company | System for using task tables and technical data from a relational database to produce a parsed file of format instruction and a standardized document |
-
2001
- 2001-08-20 WO PCT/CA2001/001194 patent/WO2002017126A2/en active Application Filing
- 2001-08-20 EP EP01966869A patent/EP1311976A2/en not_active Withdrawn
Patent Citations (2)
Publication number | Priority date | Publication date | Assignee | Title |
---|---|---|---|---|
US5228121A (en) * | 1989-09-29 | 1993-07-13 | Digital Equipment Corporation | Document generation using information engineering |
US5457792A (en) * | 1991-11-07 | 1995-10-10 | Hughes Aircraft Company | System for using task tables and technical data from a relational database to produce a parsed file of format instruction and a standardized document |
Non-Patent Citations (2)
Title |
---|
GAUGER: "Automatische Dokumentation von Automatisierungsprojekten" ATP AUTOMATISIERUNGSTECHNISCHE PRAXIS + MESSEN STEUERN REGELN , vol. 34, no. 9, September 1991 (1991-09), pages 477-484, XP000264960 M}nchen, DE * |
RADER: "AUTOMATIC DOCUMENT GENERATION WITH CASE ON A DOD AVIONICS PROJECT" PROCEEDINGS OF THE DIGITAL AVIONICS SYSTEMS CONFERENCE, vol. CONF. 10, 14 - 17 October 1991, pages 305-310, XP000309259 Los Angeles, CA, US ISBN: 0-7803-0116-1 * |
Cited By (5)
Publication number | Priority date | Publication date | Assignee | Title |
---|---|---|---|---|
EP1535129A2 (en) * | 2002-08-02 | 2005-06-01 | NRX Global SRL | Equipment documentation management system, method, and software tools |
EP1535129A4 (en) * | 2002-08-02 | 2006-10-04 | Nrx Global Srl | Equipment documentation management system, method, and software tools |
GB2404270A (en) * | 2003-07-24 | 2005-01-26 | Hewlett Packard Development Co | Document composition |
US7203902B2 (en) | 2003-07-24 | 2007-04-10 | Hewlett-Packard Development Company, L.P. | Method and apparatus for document composition |
EP1883011A1 (en) * | 2006-07-21 | 2008-01-30 | Software Ag | System and methods for generating runtime messages |
Also Published As
Publication number | Publication date |
---|---|
EP1311976A2 (en) | 2003-05-21 |
WO2002017126A3 (en) | 2002-09-26 |
Similar Documents
Publication | Publication Date | Title |
---|---|---|
US20040220815A1 (en) | Apparatus and method for the compilation, assembly, and distribution of product documentation and associated information | |
US7035837B2 (en) | Document component management and publishing system | |
US7236966B1 (en) | Method and system for providing a user-customized electronic book | |
US20030142128A1 (en) | User interface for a document component management and publishing system | |
US20040205656A1 (en) | Document rules data structure and method of document publication therefrom | |
US6651066B2 (en) | Content management system | |
US20050257158A1 (en) | Method of and system for collaboration web-based publishing | |
US20120150680A1 (en) | Automated Publishing Systems and Methods | |
CN112380823A (en) | System and method for compiling flight manual of civil aircraft | |
Gómez et al. | A framework for variable content document generation with multiple actors | |
WO2001004772A2 (en) | A method of and apparatus for generating documents | |
WO2002017126A2 (en) | Apparatus and method for the compilation, assembly, and distribution of product documentation and associated information | |
Van De Ven et al. | Metavex: Regulation drafting meets the semantic web | |
US20050097450A1 (en) | System and method for composition and decomposition of information objects | |
WO2006071368A2 (en) | System and method for information encapsulation for providing multiple deliverable formats from one information source | |
CN115170055A (en) | Knowledge engineering management platform and management method | |
CA2420009A1 (en) | Apparatus and method for the compilation, assembly, and distribution of product documentation and associated information | |
US20070106696A1 (en) | Method and system for generating a manual | |
Kommers | Scenarios for the development of educational hypermedia | |
Anastasiou et al. | Localisation standards and metadata | |
Paganelli et al. | A metadata-based approach for unstructured document management in organizations | |
JP3446472B2 (en) | Object model generation method and apparatus | |
Jennings | Microsoft Access 2010 in depth | |
Hysell | Single sourcing for translations | |
AWARE | Systems and software engineering—Content management for product life-cycle, user, and service management documentation |
Legal Events
Date | Code | Title | Description |
---|---|---|---|
AK | Designated states |
Kind code of ref document: A2 Designated state(s): CA CN US |
|
AL | Designated countries for regional patents |
Kind code of ref document: A2 Designated state(s): AT BE CH CY DE DK ES FI FR GB GR IE IT LU MC NL PT SE TR |
|
121 | Ep: the epo has been informed by wipo that ep was designated in this application | ||
DFPE | Request for preliminary examination filed prior to expiration of 19th month from priority date (pct application filed before 20040101) | ||
AK | Designated states |
Kind code of ref document: A3 Designated state(s): CA CN US |
|
AL | Designated countries for regional patents |
Kind code of ref document: A3 Designated state(s): AT BE CH CY DE DK ES FI FR GB GR IE IT LU MC NL PT SE TR |
|
WWE | Wipo information: entry into national phase |
Ref document number: 2420009 Country of ref document: CA |
|
WWE | Wipo information: entry into national phase |
Ref document number: 2001966869 Country of ref document: EP |
|
WWP | Wipo information: published in national office |
Ref document number: 2001966869 Country of ref document: EP |
|
WWE | Wipo information: entry into national phase |
Ref document number: 10344940 Country of ref document: US |