CN117075862A - Real-time function document system and method based on componentization - Google Patents
Real-time function document system and method based on componentization Download PDFInfo
- Publication number
- CN117075862A CN117075862A CN202311221388.3A CN202311221388A CN117075862A CN 117075862 A CN117075862 A CN 117075862A CN 202311221388 A CN202311221388 A CN 202311221388A CN 117075862 A CN117075862 A CN 117075862A
- Authority
- CN
- China
- Prior art keywords
- document
- component
- documents
- developer
- generating
- Prior art date
- Legal status (The legal status is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the status listed.)
- Pending
Links
- 238000000034 method Methods 0.000 title claims abstract description 36
- 238000013461 design Methods 0.000 claims description 25
- 238000010586 diagram Methods 0.000 claims description 4
- 238000005457 optimization Methods 0.000 claims description 3
- 238000004590 computer program Methods 0.000 claims description 2
- 238000012423 maintenance Methods 0.000 abstract description 7
- 238000004891 communication Methods 0.000 description 4
- 238000011161 development Methods 0.000 description 4
- 238000012360 testing method Methods 0.000 description 2
- 230000009286 beneficial effect Effects 0.000 description 1
- 230000006872 improvement Effects 0.000 description 1
- 238000012986 modification Methods 0.000 description 1
- 230000004048 modification Effects 0.000 description 1
- 230000008569 process Effects 0.000 description 1
- 230000009467 reduction Effects 0.000 description 1
- 238000006467 substitution reaction Methods 0.000 description 1
Classifications
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F8/00—Arrangements for software engineering
- G06F8/20—Software design
-
- 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/186—Templates
Abstract
The real-time function document system based on the componentization comprises a configuration document format component, a configuration description component and a template component; the configuration document format component is used for generating documents with high readability of different crowds through configuration, and generating documents with different formats according to different system functions; and/or a component for configuring the description component and the template and a custom annotation mode component. The document template further includes: a developer-style interface document, a non-developer-style various component document, a developer-style system function document, a non-developer-style interface document, a non-developer-style various component document, a non-developer-style system function document, a system summary document, a system component profile document, a system component detail document, a system function summary document, and a system function detail document. The method aims to improve the efficiency of communicating the file between the developer and the non-developer and reduce the maintenance cost of the file. The maintenance costs of the project can be reduced to a great extent.
Description
Technical Field
The application relates to the technical field of software development, in particular to a real-time functional document system and method based on componentization.
Background
In the actual development process, developers need to maintain a large number of interface documents, system function documents, etc., which may cause a large communication cost for non-developers. To solve this problem we propose a componentized system based real-time functional document solution.
Through the scheme, the efficiency of communicating the documents between the developer and the non-developer can be improved, and the document maintenance cost is reduced.
Disclosure of Invention
The embodiment of the application provides a real-time functional document system and a real-time functional document method based on componentization, which are used for improving the document communication efficiency of developers and non-developers and reducing the document maintenance cost. The automatic document tool is designed and realized through assembly, so that the maintenance cost of projects can be reduced to a great extent, and the development efficiency is improved.
The application provides a real-time function document system based on componentization, which comprises a configuration document format component, a configuration description component and a template component;
the configuration document format component is used for generating documents with high readability of different crowds through configuration, and generating documents with different formats according to different system functions;
and/or a component for configuring the description component and the template and a custom annotation mode component.
Preferably, the document template further comprises:
developer style interface document,
Various component documents other than developer styles,
Developer-style system function document,
Non-developer style interface documents,
Various component documents other than developer styles,
Non-developer style system function document,
System summary document,
System component profile,
Details of system components,
System function summary document,
And system function details.
The application provides a working method step one of a real-time functional document system based on componentization, which designs UML design drawings, comprising interface documents, component documents, document generating tools and the like. And secondly, realizing the function of realizing the automatic document tool in a modularized way by using a Java Swing framework. And thirdly, writing Java programs to realize the functions of configuring document format components and generating document tools.
Further, the method comprises the steps of,
in step one, interface document: defining various methods, attributes and parameters of the interface, and version numbers and declaration time of the interface;
component document: defining interfaces, attributes and methods of the components, and version numbers and declaration times of the components; generating a document tool: define the functionality of the document creation tool, and the method of creating different types of documents.
Further, the method comprises the steps of,
in step one, an appropriate document format is selected: selecting a proper document format according to project requirements, wherein the document format comprises HTML and XML;
defining a document structure: the structure of different types of documents is defined according to the UML design drawing,
generating a document template: templates for generating different types of documents from UML design drawings, including text, labels, notes
Realizing the modularization: and the componentization support is provided for the configuration of the components, so that a developer can customize the style and the color of the components.
Still further, the method further comprises the steps of,
in step two, the required libraries are introduced: the required Java library is imported, for example Swing, javaDoc. And (3) groupwise: realizing componentization through a Swing framework, defining interfaces, attributes and methods of components, and version numbers and declaration time of the components;
a configuration document format component: the method comprises the steps of realizing the function of configuring a document format component, including selecting a proper document format, defining a document structure and generating a document template;
generating a document tool: the function of generating a document tool is realized, which comprises the steps of analyzing UML design drawings, generating different types of documents and realizing code optimization.
Further, in step one, a uml.xml file is imported: defining a UML design drawing according to a UML.XML file;
defining a UML design diagram: defining UML structures of different types of documents according to UML design drawings;
generating a UML design drawing: data structures for different types of documents are generated from the UML design diagram.
In a third aspect, the present application also provides a computer readable storage medium storing a computer program which, when executed by a processor, implements the method of the second aspect.
Compared with the prior art, the embodiment of the application has the beneficial effects that:
1. the burden of maintaining system documents by developers is greatly reduced.
2. The system and the method can generate the current system function and the related documents of the interface in real time, so that personnel (developers, client managers, leaders and the like) of all parties can quickly know the current system state of a certain system. The communication cost among all the parties is reduced.
3. The current system state can be quickly known, and the new functions of the system can be quickly promoted. The fast changing market is dealt with in time.
Detailed Description
In the following description, for purposes of explanation and not limitation, specific details are set forth such as the particular system architecture, techniques, etc., in order to provide a thorough understanding of the embodiments of the present application. It will be apparent, however, to one skilled in the art that the present application may be practiced in other embodiments that depart from these specific details. In other instances, detailed descriptions of well-known systems, devices, circuits, and methods are omitted so as not to obscure the description of the present application with unnecessary detail.
Reference in the specification to "one embodiment" or "some embodiments" or the like means that a particular feature, structure, or characteristic described in connection with the embodiment is included in one or more embodiments of the application. Thus, appearances of the phrases "in one embodiment," "in some embodiments," "in other embodiments," and the like in the specification are not necessarily all referring to the same embodiment, but mean "one or more but not all embodiments" unless expressly specified otherwise. The terms "comprising," "including," "having," and variations thereof mean "including but not limited to," unless expressly specified otherwise.
Having better described the functions and methods of use of the embodiments, a complete example document is provided below, including the functions, methods of configuration, methods of use, etc. of the embodiments.
The embodiment provides a working method of a real-time functional document system based on componentization, which comprises the following steps:
step one, designing UML design drawings, including interface documents, component documents, and document generating tools. Interface document: defining various methods, attributes and parameters of the interface, and version numbers and declaration time of the interface;
component document: defining interfaces, attributes and methods of the components, and version numbers and declaration times of the components;
generating a document tool: define the functionality of the document creation tool, and the method of creating different types of documents.
Selecting an appropriate document format: selecting a proper document format according to project requirements, wherein the document format comprises HTML and XML;
defining a document structure: the structure of different types of documents is defined according to the UML design drawing,
generating a document template: templates for different types of documents are generated from the UML design drawings, including text, labels, notes,
realizing the modularization: and the componentization support is provided for the configuration of the components, so that a developer can customize the style and the color of the components.
And secondly, realizing the function of realizing the automatic document tool in a modularized way by using a Java Swing framework.
Introducing the required libraries: the required Java library is imported, for example Swing, javaDoc.
And (3) groupwise: realizing componentization through a Swing framework, defining interfaces, attributes and methods of components, and version numbers and declaration time of the components;
and thirdly, writing Java programs to realize the functions of configuring document format components and generating document tools.
1. Overview of the functionality
The automatic document design and realization are realized through the componentization, so that the maintenance cost of projects can be greatly reduced, and the development efficiency is improved. The embodiment mainly comprises the following functions:
a configuration document format component: documents which can be understood by different groups (developers/non-developers) can be generated according to the configuration, documents with different formats can be generated according to different system functions, and the like.
Configuration description component and template component: such as custom annotation mode components, to meet the needs of different scenarios.
Generating a document tool: the method comprises two parts of a configuration document format component and a document generating tool.
2. Configuration document format component
Configuration document format component
Documents that can be understood by different groups of people (developers/non-developers) are generated according to the configuration, for example:
the developer: developer style interface documents, various component documents, system function documents, and the like.
Non-developer: interface documents other than developer styles, various component documents, system function documents, and the like.
Configuration description component and template component
Such as a custom annotation mode component to meet the requirements of different scenarios, for example:
the developer: the custom annotation mode component is used for generating interface documents, component documents, system function documents and the like special for developers.
Non-developer: the custom annotation mode component is used for generating interface documents, component documents, system function documents and the like which are not special for developers.
3. Document generation tool
Document generation tool
The tool comprises a configuration document format component and a document generating tool.
Configuration document format component
Documents that can be understood by different groups of people (developers/non-developers) are generated according to the configuration, for example:
the developer: developer style interface documents, various component documents, system function documents, and the like.
Non-developer: interface documents other than developer styles, various component documents, system function documents, and the like.
Document generation tool
The method comprises two parts of a configuration document format component and a document generating tool.
4. Application method
Configuration document format component
The document format component is configured according to actual requirements, for example:
configuration generation interface document: the interface document is generated according to the module and the function configuration of the interface, and different interface documents, such as a Web service interface document, a database interface document and the like, can be generated according to the type of the interface.
Configuration generation component document: the component document is generated according to the function and type configuration of the component, and different component documents, such as a button component document, a text box component document, etc., can be generated according to the function and annotation configuration of the component.
Configuration generation system function document: the system function document is generated according to the function and the module configuration of the system, and different system function documents, such as a function module document, a data sheet document and the like, can be generated according to the function and the module configuration of the system.
Document generation tool
After the document format component is configured using the document creation tool, the document creation tool automatically creates documents that are understandable to different groups of people (developers/non-developers). For example:
the developer: interface documents, component documents, system function documents, etc.
Non-developer: interface documents, component documents, system function documents, etc.
Document generation tool
After the document format component is configured using the document creation tool, the document creation tool automatically creates documents that are understandable to different groups of people (developers/non-developers). For example:
the developer: developer-specific interface documents, component documents, system function documents, and the like.
Non-developer: non-developer specific interface documents, component documents, system function documents, and the like.
The component custom annotation mode component of the configuration description component and the template can be used for meeting the requirements of different scenes. For example:
the developer: the custom annotation mode component is used for generating interface documents, component documents, system function documents and the like special for developers.
Non-developer: the custom annotation mode component is used for generating interface documents, component documents, system function documents and the like which are not special for developers.
Document generation tool
The document generating tool comprises a configuration document format component and a document generating tool.
Configuration document format component
Documents that can be understood by different groups of people (developers/non-developers) are generated according to the configuration, for example:
the developer: developer style interface documents, various component documents, system function documents, and the like.
Non-developer: interface documents other than developer styles, various component documents, system function documents, and the like.
Document generation tool
After the document format component is configured using the document creation tool, the document creation tool automatically creates documents that are understandable to different groups of people (developers/non-developers). For example:
the developer: interface documents, component documents, system function documents, etc.
Non-developer: interface documents, component documents, system function documents, etc.
Configuration description component and template component
Such as a custom annotation mode component to meet the requirements of different scenarios, for example:
the developer: the custom annotation mode component is used for generating interface documents, component documents, system function documents and the like special for developers.
Non-developer: the custom annotation mode component is used for generating interface documents, component documents, system function documents and the like which are not special for developers.
Document generation tool
After the document format component is configured using the document creation tool, the document creation tool automatically creates documents that are understandable to different groups of people (developers/non-developers). For example:
the developer: developer-specific interface documents, component documents, system function documents, and the like.
Non-developer: interface documents, component documents, system function documents, etc.
Project implementation
And designing a UML design drawing and determining a Java Swing framework implementation scheme.
Java programs are written to realize the functions of configuring document format components and generating document tools.
And performing unit test to ensure the code quality.
And finishing the development work of the whole project.
Performance problems of the Java Swing framework: may result in slower running speeds of the document creation tool, requiring optimization.
Function implementation problem of the automatic document tool is realized in a componentization manner: a situation may be encountered where the component configuration is incompatible, requiring testing and debugging.
And evaluating the improvement condition of the document communication efficiency of the developer and the non-developer.
The document generation efficiency and the maintenance cost reduction degree of the automatic document tool are evaluated and componentized.
The code quality and maintainability of the project is assessed.
In the foregoing embodiments, the descriptions of the embodiments are emphasized, and in part, not described or illustrated in any particular embodiment, reference is made to the related descriptions of other embodiments.
Those of ordinary skill in the art will appreciate that the various illustrative elements and algorithm steps described in connection with the embodiments disclosed herein may be implemented as electronic hardware, or combinations of computer software and electronic hardware. Whether such functionality is implemented as hardware or software depends upon the particular application and design constraints imposed on the solution. Skilled artisans may implement the described functionality in varying ways for each particular application, but such implementation decisions should not be interpreted as causing a departure from the scope of the present application.
The above embodiments are only for illustrating the technical solution of the present application, and not for limiting the same; although the application has been described in detail with reference to the foregoing embodiments, it will be understood by those of ordinary skill in the art that: the technical scheme described in the foregoing embodiments can be modified or some technical features thereof can be replaced by equivalents; such modifications and substitutions do not depart from the spirit and scope of the technical solutions of the embodiments of the present application, and are intended to be included in the scope of the present application.
Claims (8)
1. A real-time function document system based on componentization is characterized by comprising a configuration document format component and
configuring a description component and a template component;
the configuration document format component is used for generating documents with high readability of different crowds through configuration, and generating documents with different formats according to different system functions;
and/or a component for configuring the description component and the template and a custom annotation mode component.
2. The componentized-based real-time functional document system of claim 1, wherein the document template further comprises:
developer style interface document,
Various component documents other than developer styles,
Developer-style system function document,
Non-developer style interface documents,
Various component documents other than developer styles,
Non-developer style system function document,
System summary document,
System component profile,
Details of system components,
System function summary document,
And system function details.
3. The componentized real-time function document system of claim 1, wherein,
step one, designing UML design drawings, including interface documents, component documents, and document generating tools.
And secondly, realizing the function of realizing the automatic document tool in a modularized way by using a Java Swing framework.
And thirdly, writing Java programs to realize the functions of configuring document format components and generating document tools.
4. The componentized-based real-time function document system of claim 1, wherein in step one, the interface document: defining various methods, attributes and parameters of the interface, and version numbers and declaration time of the interface;
component document: defining interfaces, attributes and methods of the components, and version numbers and declaration times of the components;
generating a document tool: define the functionality of the document creation tool, and the method of creating different types of documents.
5. The componentized real-time function document system of claim 1, wherein,
in step one, an appropriate document format is selected: selecting a proper document format according to project requirements, wherein the document format comprises HTML and XML;
defining a document structure: the structure of different types of documents is defined according to the UML design drawing,
generating a document template: templates for generating different types of documents from UML design drawings, including text, labels, notes
Realizing the modularization: and the componentization support is provided for the configuration of the components, so that a developer can customize the style and the color of the components.
6. The componentized-based real-time function document system of claim 1, wherein, in
In step two, the required libraries are introduced: the required Java library is imported, for example Swing, javaDoc. And (3) groupwise: realizing componentization through a Swing framework, defining interfaces, attributes and methods of components, and version numbers and declaration time of the components;
a configuration document format component: the method comprises the steps of realizing the function of configuring a document format component, including selecting a proper document format, defining a document structure and generating a document template;
generating a document tool: the function of generating a document tool is realized, which comprises the steps of analyzing UML design drawings, generating different types of documents and realizing code optimization.
7. The componentized-based real-time functional document system of claim 1, wherein in step one, a uml.xml file is imported: defining a UML design drawing according to a UML.XML file;
defining a UML design diagram: defining UML structures of different types of documents according to UML design drawings;
generating a UML design drawing: data structures for different types of documents are generated from the UML design diagram.
8. A computer readable storage medium having stored thereon a computer program which, when executed by a processor, implements the steps of the method according to claims 1-7.
Priority Applications (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN202311221388.3A CN117075862A (en) | 2023-09-20 | 2023-09-20 | Real-time function document system and method based on componentization |
Applications Claiming Priority (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN202311221388.3A CN117075862A (en) | 2023-09-20 | 2023-09-20 | Real-time function document system and method based on componentization |
Publications (1)
| Publication Number | Publication Date |
|---|---|
| CN117075862A true CN117075862A (en) | 2023-11-17 |
Family
ID=88709944
Family Applications (1)
| Application Number | Title | Priority Date | Filing Date |
|---|---|---|---|
| CN202311221388.3A Pending CN117075862A (en) | 2023-09-20 | 2023-09-20 | Real-time function document system and method based on componentization |
Country Status (1)
| Country | Link |
|---|---|
| CN (1) | CN117075862A (en) |
-
2023
- 2023-09-20 CN CN202311221388.3A patent/CN117075862A/en active Pending
Similar Documents
| Publication | Publication Date | Title |
|---|---|---|
| US6934940B2 (en) | Source code transformation-temporary object reduction | |
| JPH08202545A (en) | Object-oriented system and method for generation of target language code | |
| US20050060688A1 (en) | Automated source code software programmer's manual generator | |
| CN102306102A (en) | Method and device for automatically generating program file | |
| CN108170409B (en) | Development method and system of WEB front-end control | |
| CN111813393A (en) | Application program development method and device | |
| US20060041873A1 (en) | Computer system and method for verifying functional equivalence | |
| CN110968294A (en) | Business domain model establishing system and method | |
| US20070277165A1 (en) | Debugging Interpreted Input | |
| CN110795091A (en) | Modular routing decoupling method, storage medium, electronic device and system | |
| CN112083926A (en) | Web user interface generation method and device | |
| US20110138350A1 (en) | System and method for pattern based services extraction | |
| CN117075862A (en) | Real-time function document system and method based on componentization | |
| JP2008165342A (en) | Source code creating method, device and program | |
| JP2008140263A (en) | Unit test support device | |
| CN106874014B (en) | Three-layer code generation method based on model and framework | |
| CN113961238A (en) | Object conversion method and device, electronic equipment and storage medium | |
| CN113885841A (en) | Script generation method and device, electronic equipment and readable medium | |
| CN113821195A (en) | Method, device and equipment for generating executable program of target language | |
| CN113448874A (en) | Method and device for generating unit test script | |
| CN113703769B (en) | CLI command execution method and related device | |
| Tilley | Documenting software systems with views VI: lessons learned from 15 years of research & practice | |
| CN112685049B (en) | JAVA byte code compiling method | |
| CN117971228A (en) | Automatic generation method and system for C# code and electronic device | |
| JP2006221556A (en) | Program execution device, program execution method and program |
Legal Events
| Date | Code | Title | Description |
|---|---|---|---|
| PB01 | Publication | ||
| PB01 | Publication | ||
| SE01 | Entry into force of request for substantive examination | ||
| SE01 | Entry into force of request for substantive examination |