Summary of the invention
Technical matters solved by the invention is to provide a kind of user manual to generate method and system.
A kind of user manual generation method is provided in the embodiment of the invention, has comprised the steps:
Definite product that needs the user manual of generation;
Foundation is used for the information exchange platform of described product;
The personnel relevant with described product provide the information relevant with described product by described information exchange platform;
Gather information relevant on the described information exchange platform and generate user manual with described product.
Preferably, set up when being used for the information exchange platform of described product, setting up with the article based on the basic technology of dimension is the structure system at center.
Preferably, further comprise:
Be the different personnel setting different access rights relevant with described product.
Preferably, gather information relevant on the described information exchange platform and generate user manual, comprising with described product:
Travel through the information relevant that exists on the described information platform with described product;
With the page table name on the described information platform is the title name of user manual;
To unite the content of searching in the text table that is found on described information platform is the content body of user manual;
Generate the off-line html file by title name and content corresponding coupling back, and with its stock as user manual.
Preferably, further comprise:
After generating the off-line html file, to the file hyperlinked information is positioned again in the html file.
Preferably, behind the generation off-line html file, further comprise:
Adopt the form of the document of chm form, word form or pdf form as user manual.
Preferably, adopt the form of the document of chm form, comprising as user manual:
Adopt the XML file to generate the intermediate of chm file as html file.
A kind of user manual generation system is provided in the embodiment of the invention, has comprised:
Information exchange platform is used to the personnel relevant with product that the information relevant with product is provided, and described information exchange platform is the information exchange platform of setting up behind the product of the user manual of determining to generate that is used for described product;
Generation module is used to gather information relevant with described product on the described information exchange platform and generates user manual.
Preferably, to be further used for setting up with the article based on the basic technology of dimension be the structure system at center to information exchange platform.
Preferably, further comprise:
Administration module is used to the different personnel setting different access rights relevant with described product.
Preferably, generation module comprises:
The traversal unit is used to travel through the information relevant with described product that exists on the described information platform;
The title generation unit, being used for the page table name on the described information platform is the title name of user manual;
The content generation unit, being used for to unite the content of searching the text table that is found on described information platform is the content body of user manual;
The handbook generation unit is used for generating the off-line html file by title name and content corresponding coupling back, and with its stock as user manual.
Preferably, the handbook generation unit is further used for after generating the off-line html file, to the file hyperlinked information is positioned again in the html file.
Preferably, the handbook generation unit is further used for after generating the off-line html file, adopts the form of the document of chm form, word form or pdf form as user manual.
Preferably, the handbook generation unit is further used for during as the form of user manual, adopting XML (eXtensible Markup Language, extend markup language) file to generate the intermediate of chm file as html file at the document that adopts the chm form.
Beneficial effect of the present invention is as follows:
In the technical scheme that the embodiment of the invention provides, owing to behind the product of the user manual of determining to generate, just set up the information exchange platform that is used for described product; Make the personnel relevant to provide the information relevant by this information exchange platform with described product with product; Thereby the information relevant with described product generates user manual on can the Information Monitoring interaction platform.
Because the personnel relevant with product can provide the information relevant with product by information exchange platform, that is to say, the user manual of software is not only finished by product development person, product test person, user also can participate in the information updating process of this user manual generation system, thereby have guaranteed that the information that user manual provided is real-time and effective.
Further, when foundation is used for the information exchange platform of described product, be based on that the framework of the basic WiKi platform of dimension sets up, owing to adopt the dimension based platform that customized as storage medium, therefore, canned data can constantly upgrade in the storage medium.
Further,, creatively use the file storage organizational information of XML form, therefore, realized the process that information automation is derived in the user manual storage medium owing to adopted the intermediate of XML file as html file generation chm file.The information that can provide according to information exchange platform, robotization generates the information document of various off-lines and the organizational information of these information documents.
Further, when the robotization of user manual generates,, therefore these message block can be made into the document of complete chm form owing to can utilize the organizational information of the XML form of deriving information off-line document and these information documents.
Further, owing to be the title name of user manual with the page table name on the described information platform; To unite the content of searching in the text table that is found on described information platform is the content body of user manual; And by title name and content corresponding coupling back generation off-line html file, and with it as user manual.Therefore, the off-line document of generation possesses institutional framework such as catalogue, index clearly, and can support the full-text search function.
As seen from the above-described embodiment, the technical scheme that provides in the embodiment of the invention has proposed a kind of robotization generting machanism of user manual, make and to write the special manpower that expends that user manual no longer needs, can guarantee that the user manual generation system can real-time update, that supports user manual onlinely checks that the robotization with the offline user handbook generates, and has improved the formation efficiency and the properties of product of user manual generation system greatly.
Embodiment
In the invention process, the inventor notices: the target of the design of user manual generation system is mainly overcoming several big shortcomings, and saves the labour to greatest extent.
At first, to be write by the special messenger be unscientific to user manual.The technical scheme that the embodiment of the invention provides will be made improvement to this point.A user manual is split into a lot of parts.Each part is write by its corresponding developer, because he is the clearest to the intention of this part functional module exploitation.And then it is the each several part document is unified to together.
Secondly, should be able to guarantee that the user manual generation system can real-time update.The technical scheme that the embodiment of the invention provides will be released the platform of an opening, online user's handbook generation system.This platform is the center with the article.The text that it is initial is exactly the user manual of the each several part that provides of software developer.The user manual of each several part provide finish after, developer, tester and various user can propose suggestion for revision or participate in revising.Simultaneously, after the Product Renewal upgrading, the developer can revise original user manual generation system, makes the user manual generation system always in real time effectively.
Once more, product should have a complete relatively stable user manual in issue.The technical scheme that the embodiment of the invention provides will utilize existing online user's handbook generation system to generate a complete user manual, issue jointly in company with product.User manual in company with issue is suitable for consulting.As: a distinct catalogue is arranged, support function of search simultaneously, or the like.
Below in conjunction with accompanying drawing the specific embodiment of the present invention is described.
Fig. 1 is user manual generation method implementing procedure synoptic diagram, as shown in the figure, can comprise the steps: when generating user manual
Step 101, definite product that needs the user manual of generation;
Step 102, foundation are used for the information exchange platform of described product;
Step 103, the personnel relevant with described product provide the information relevant with described product by described information exchange platform;
The information relevant with described product generates user manual onstep 104, the described information exchange platform of collection.
Following elder generation describes the enforcement of information exchange platform.
In the enforcement, set up when being used for the information exchange platform of product, can set up with the article based on the basic technology of dimension is the structure system at center.
Concrete, in the enforcement with the carrier of an information exchange platform as all information.This platform can be used for reference the thought of building of dimension base (WiKi) platform, is the center with the article, makes it to be fit to the mutual of knowledge.
In the enforcement, can further include: be the different personnel setting different access rights relevant with described product.Concrete, platform user has the message reference authority of different stage, and according to access rights, platform user can be divided into developer, tester, keeper and user etc.To the information on the platform, various users can both correct in the scope of different rights, can bring in constant renewal in as required to impel the information on the platform, can be consistent with product development, also can satisfy user's demand simultaneously.
Fig. 2 is the information exchange platform synoptic diagram, and as shown in the figure, developer, user, tester, system manager can carry out information interaction by information exchange platform.
Information exchange platform is divided into information stores and information haply and derives two functional modules on function.Describe respectively below.
1, information derives.
In the enforcement, when the information relevant with described product generates user manual on gathering described information exchange platform, can comprise:
Travel through the information relevant that exists on the described information platform with described product;
With the page table name on the described information platform is the title name of user manual;
To unite the content of searching in the text table that is found on described information platform is the content body of user manual;
Generate the off-line html file by title name and content corresponding coupling back, and with its stock as user manual.
Concrete, with the dimension base net station that customized as interaction platform, store information.On this basis, the stored information in dimension base net station can be exported to html file.All online html pages (content all exists in the database) that traversal exists, the title name that provides in the page table in the use database is as the title name of final html file, to unite the content of searching in the text table that is found is the html file content body, again display format etc. is carried out certain reprocessing, generate the off-line html file, these off-line html files are stored in the file of an appointment the most at last.Because the hyperlink form of offline user handbook and online user's handbook can't be compatible, directly the offline user handbook that generates does not have hyperlinked information, therefore after generating the off-line html file, can reorientate the file hyperlinked information.That is, can further include in the enforcement: after generating the off-line html file, the file hyperlinked information is positioned again in the html file.
2, the offline user handbook generates.
Information is gathered around and is had plenty of scattered html file after deriving, and what finally will form is complete user manual.Can adopt the principal mode of the document of chm form in the enforcement as user manual.And, can generate various forms of user manuals such as word, pdf as required.Wherein, PDF (PortableDocument Format, portable file layout) is the file layout that was developed with the what exchange files in 1993 by Adobe Systems.。
In concrete the enforcement, html file all is stored under the file at the beginning, but this scattered file that is a pile.Need to resolve the specific page on the online website, the organizational form that obtains html file should have the function of full-text search simultaneously as a good user manual file.Different with on-line search, the offline user handbook does not have the database support of bottom, therefore can't support the full-text search of user manual file as being supported in line search.
Therefore, can adopt the intermediate of XML file in the enforcement, that is, can adopt the XML file to generate the intermediate of chm file as discrete html file as html file generation chm file.Because html file itself is discrete and rambling, it is regular to utilize the XML file that it is carried out, and the institutional framework of standard so just can be provided for the chm file.
Fig. 3 is the transfer process synoptic diagram, as shown in the figure, utilizes the XML structured file of standard discrete html file to be resolved the XML file that generates standard.
The technical scheme that provides among the embodiment will be set forth the angle of the use of information exchange platform from sorts of relevant personnel below for a better understanding of the present invention, so that better understand the enforcement of technical scheme provided by the invention.
Fig. 4 as shown in the figure, can comprise the steps: for the use implementing procedure synoptic diagram that user manual generates
Step 401, software developer A, B ... N writes the document of the module of its exploitation;
Step 402, all software developers are put into its user manual of writing on the public platform;
Step 403, platform management personnel are carried out to a certain degree management, integration to user manual;
Step 404, judge software whether have the upgrading and big renewal, be then to changestep 405 over to, otherwise changestep 406 over to;
Step 405, software developer upgrade to user manual and revise;
Step 406, judge whether to need the issue user manual, be then to changestep 409 over to, otherwise changestep 407 over to;
Step 407, software developer, tester, user to user handbook use feedback opinion;
Step 408, at the problem that proposes, the software developer upgrades user manual;
The complete relatively user manual of the chm form ofstep 409, generation off-line.
Can find that from above-mentioned implementation process user manual is to be in the process of continual renovation, feedback is constantly revised in real time, makes the user always can obtain the most suitable up-to-date user manual like this.Thereby can use software product better.Simultaneously, for the use needs of product, can generate the up-to-date user manual of off-line at any time.
Based on same inventive concept, a kind of user manual generation system also is provided in the embodiment of the invention, because the principle that this system deals with problems is similar to user manual generation method, so the enforcement of this system can repeat part and repeat no more referring to the enforcement of method.
Fig. 5 is a user manual generation system structural representation, as shown in the figure, can comprise in the system:
Information exchange platform 501 is used to the personnel relevant with product that the information relevant with product is provided, and described information exchange platform is the information exchange platform of setting up behind the product of the user manual of determining to generate that is used for described product;
Generation module 502 is used to gather information relevant with described product on the described information exchange platform and generates user manual.
In the enforcement, it is the structure system at center that information exchange platform can also be further used for setting up with the article based on the basic technology of dimension.
In the enforcement, can further include:
Administration module 503 is used to the different personnel setting different access rights relevant with described product.
In the enforcement, generation module can comprise:
The traversal unit is used to travel through the information relevant with described product that exists on the described information platform;
The title generation unit, being used for the page table name on the described information platform is the title name of user manual;
The content generation unit, being used for to unite the content of searching the text table that is found on described information platform is the content body of user manual;
The handbook generation unit is used for generating the off-line html file by title name and content corresponding coupling back, and with its stock as user manual.
In the enforcement, the handbook generation unit can also be further used for after generating the off-line html file, to the file hyperlinked information is positioned again in the html file.
In the enforcement, the handbook generation unit can also be further used for after generating the off-line html file, adopts the form of the document of chm form, word form or pdf form as user manual.
In the enforcement, the handbook generation unit can also be further used for during as the form of user manual, adopting the XML file to generate the intermediate of chm file as html file at the document that adopts the chm form.
For the convenience of describing, the each several part of the above device is divided into various modules with function or the unit is described respectively.Certainly, when enforcement is of the present invention, can in same or a plurality of softwares or hardware, realize the function of each module or unit.
As seen from the above-described embodiment, the technical scheme that provides in the embodiment of the invention has proposed a kind of robotization generting machanism of user manual, make and to write the special manpower that expends that user manual no longer needs, can guarantee that the user manual generation system can real-time update, that supports user manual onlinely checks that the robotization with the offline user handbook generates, and has improved the formation efficiency and the properties of product of user manual generation system greatly.
Those skilled in the art should understand that embodiments of the invention can be provided as method, system or computer program.Therefore, the present invention can adopt complete hardware embodiment, complete software implementation example or in conjunction with the form of the embodiment of software and hardware aspect.And the present invention can adopt the form that goes up the computer program of implementing in one or more computer-usable storage medium (including but not limited to magnetic disk memory, CD-ROM, optical memory etc.) that wherein include computer usable program code.
The present invention is that reference is described according to the process flow diagram and/or the block scheme of method, equipment (system) and the computer program of the embodiment of the invention.Should understand can be by the flow process in each flow process in computer program instructions realization flow figure and/or the block scheme and/or square frame and process flow diagram and/or the block scheme and/or the combination of square frame.Can provide these computer program instructions to the processor of multi-purpose computer, special purpose computer, Embedded Processor or other programmable data processing device to produce a machine, make the instruction of carrying out by the processor of computing machine or other programmable data processing device produce to be used for the device of the function that is implemented in flow process of process flow diagram or a plurality of flow process and/or square frame of block scheme or a plurality of square frame appointments.
These computer program instructions also can be stored in energy vectoring computer or the computer-readable memory of other programmable data processing device with ad hoc fashion work, make the instruction that is stored in this computer-readable memory produce the manufacture that comprises command device, this command device is implemented in the function of appointment in flow process of process flow diagram or a plurality of flow process and/or square frame of block scheme or a plurality of square frame.
These computer program instructions also can be loaded on computing machine or other programmable data processing device, make on computing machine or other programmable devices and to carry out the sequence of operations step producing computer implemented processing, thereby the instruction of carrying out on computing machine or other programmable devices is provided for being implemented in the step of the function of appointment in flow process of process flow diagram or a plurality of flow process and/or square frame of block scheme or a plurality of square frame.
Although described the preferred embodiments of the present invention, in a single day those skilled in the art get the basic creative notion of cicada, then can make other change and modification to these embodiment.So claims are intended to all changes and the modification that are interpreted as comprising preferred embodiment and fall into the scope of the invention.