Integration of program documents and dynamic documents

Hong Hai Liao Jing

Many enterprises have established many large computer management systems and will continuously launch new systems. To meet the business needs, the computer system must be constantly maintained and transformed, but the current production should not be affected at the same time. Therefore, a complete set of mechanisms must be established to evaluate, control, and complete system maintenance. In the software maintenance process, the concept of integration of program and document is proposed to establish dynamic documents while developing software. Introduction to the concept of integration of program and document I. Current Software status Separated programs and documents are stored in separate forms, and different tools are used for writing and searching at different times. During program maintenance, documents cannot be conveniently obtained, and documents cannot be modified simultaneously. Separation of program and document content, because the program and document use different descriptions, both computer language and natural language. In the maintenance process, documents or programs cannot be updated in a timely and consistent manner, so that documents cannot accurately describe the program, which is almost a waste of paper or even brings negative value. The separation of software development and maintenance makes it easier for most software to design and develop without considering possible modifications in the future. It also makes maintenance easy to introduce new errors. Such separation is also manifested in incompatibility between documents at different stages of design and development. For example, the requirement analysis specification is something on paper, in the outline design stage, the requirement analysis specification cannot be well inherited and used. The design and preparation of the outline design must start from scratch and need to be re-analyzed and understood, it not only delays the development progress and increases the burden on the designers, but also causes many incompatible objects described at different stages due to different understandings. These separation reduces the role of documents in system design, development, and maintenance, which is also the main reason why many software personnel are reluctant to write documents. Ii. Concepts of integration of procedures and documents How is a good document system? The following attributes should be available: 1. can accurately describe the software and be easy to understand; 2. Fast error locating, impact analysis, and correction design; 3. improve software maintenance quality; 4. The program can be understood during program modification. To this end, the concept of integration of procedures and documents is proposed. This concept makes software a true software: Programs + documents, programs are documents, and documents are integrated into programs. It requires that when selecting a development environment, we should not only consider the perfect support for design and development, but also the support for maintenance and documentation; it requires software personnel to consider maintenance and documentation issues during design and development; it requires that the program and documents are stored in the same location and system; it requires the use of the same tool for the writing and retrieval of programs and documents; it requires the formation of documents while writing and maintaining programs, and the preparation and maintenance of programs when writing documents. The concept of integration of program and document exists not only in the system design and development stage but also in the system maintenance stage, which runs through the software life cycle. A dynamic document system is an online document system that is consistent with the program and easy to understand based on the concept of integration of programs and documents. It includes component description and data description, and describes the relationship between components and data. The dynamic document system improves the availability, usability, and consistency of documents, makes documents more effective, and is an effective way to solve maintenance problems. Dynamic Document System Problem Analysis The problems to be solved are: division and acquisition of software documents, storage and maintenance of documents, retrieval of documents, and generation and printing of Software Documents. I. The content of Software Documents is divided into semantic documents, structural documents, and process documents. A semantic document is a natural language description of software functions, concepts, overall design, processes, and conventions. It is a document written and entered into the program by software personnel based on the case tool, it is also additional information that can be flexibly added to a more comprehensive interpretation document. The structure document describes the attributes of objects in software design tools and development environments, interfaces between components, reference relationships between components, and the structure of software. The Lexical and syntax analysis programs are used to identify and analyze the objects and components of the entire system, obtain the preceding descriptions, and form a table file. Process documents are process descriptions and program comments formed during the software design, coding, and maintenance processes, such as descriptions of design purpose, designer, and time, use the development environment to track the Operation Records of software engineers during design, development, and maintenance. Ii. Unified Storage and maintenance of programs and documents According to the concept of integration of programs and documents and the requirements for extracting documents from the program, documents must be stored in the program, and even the inherent source code of the document. The storage of program source code with such a structure must adopt a new technology-Object Storage (repository) technology, rather than streaming files, so that programs and documents can be combined and separated. Programs and documents are combined in an object warehouse and in a unified development environment. When you modify code, you can modify the document and modify the document manually, manually entered documents are not lost after multiple documents are generated. Programs and documents should be stored in different tables or fields in the object warehouse respectively, and separated during compilation and runtime. Iii. Document Retrieval A single object and component document can be retrieved and maintained together with the source code if the document is stored in an object warehouse. This retrieval provides document support for analysis and maintenance of a single component and object. Create multiple views, write programs to search and obtain documents of the entire system, analyze the entire system, and support documents of the entire system in real time. This will be described in detail in the example. 4. Generate and Print Software Documents Compile a program to search and obtain documents of the entire system, document templates are created based on the document patterns of national software standards, and documents are generated based on templates, and documents are created, edited, and printed using the powerful features of the word processing software. According to the above analysis, document distribution and acquisition require the development environment: the development environment should be the integration of design tools and development tools, it should be based on case technology, object storage technology, component technology, and OLE technology. Development Environment Based on case technology; Design, development, maintenance documents formed during the process and embedded in the program code, make the document a part of the program. Based on the development environment of Object Storage Technology, documents and programs are stored in the object storage for convenient retrieval. The Development Environment Based on Component Technology makes it easy to identify and obtain components, analyze and form structure documents and process documents. Based on OLE and other technologies, documents can make good use of documents processing software such as Word. An application instance of the dynamic Document System Guangzhou Telecom Technology Development Co., Ltd. independently designed and developed the huge telecommunications management computer system named jiuqi system, which will be used for production for a long time after it was put into operation and accepted in 1997. maintenance work is very important and urgent. This provides a demand and test site for the dynamic document system. During the long-term maintenance process, I realized the importance of the document and proposed the concept of program document integration, which provides a theoretical basis for the dynamic document system. The system is developed using the uniform development environment. This development environment uses case technology, object storage technology, and component technology, which provides technical support for dynamic document systems. 1. Procedure for Establishing Guangzhou Telecom's dynamic Document System 1. Understand the development environment of uniform and oracle tools, plan tables and fields stored in semantic documents among objects at all levels, and set rules based on the features of the tools. 2. Search for tables and fields stored in the structure document and process document in the uniface and oracle tools. 3. Fill in the tables or fields according to the Rules during the design, development and maintenance of the software. 4. Create a complete set of templates to create images for document structures and information sources, including data dictionary templates, design document templates, structure document templates, and development process document templates. 5. Assemble these templates into a document system and make them independent from the development target system. The dynamic documentation system of Guangzhou Telecom can be divided into document query, maintenance record query, and document generation. Document query includes not only component description and data description, but also the relationship between components and data. It is a real-time online document query system. Maintenance record query records and traces all processes in the software maintenance process, and is used to standardize maintenance work. It includes problem report, problem analysis, error locating, maintenance design, maintenance execution, validation testing, maintenance review, maintenance submission, problem tracking, etc. Document generation generates the software design specification in real time as needed. Ii. Concepts of integration of procedures and documents and significance of dynamic document systems The basic tasks of Guangzhou Telecom's dynamic document system are to assist in error locating, maintenance impact analysis, record maintenance processes, and generate documents. Developed using the development environment of uniform can be installed in different application systems developed using uniform. The system has played an important role in the maintenance of the 9th and 7th billing systems. It advocates the concept of integration of procedures and documents. It puts forward that documents are programs, and programs are the ideas of documents. Documents are integrated into the ideas and implementations of programs, this concept guides software personnel to work effectively. The concept of integration runs through the entire software cycle of design, development, and maintenance, ensuring the inheritance and consistency between documents, each stage of design and development is the result of inheriting the programs and documents of the previous stage. This greatly eliminates inconsistencies between programs and documents, documents and documents, accelerates the software design progress, and improves the quality of software development and maintenance. It is an attempt of Software Engineering in specific applications. It further standardizes software design, development, and maintenance from the perspective of integration of program documents. The concept of integration of program documents provides a way of thinking for the development of the software development environment. A better object warehouse is designed to meet the requirements of developers and maintenance personnel for the concept of integration of program documents. Limitations and development of dynamic Document System Guangzhou Telecom's dynamic document system has many limitations and can only be used in systems developed by uniform or Oracle. Currently, the identification and acquisition of components of Guangzhou Telecom's dynamic document system relies mainly on the features of components and components provided by development tools for identification. This dynamic document system is difficult to combine and separate programs and documents in some 3gl tools-software developed without object warehousing technology and component technology. The environment of a large software system is complex. A variety of development environments are often used. Technical Discussion and practical exploration are required to support other development environments. Another limitation is that the current dynamic document system describes program documents, which are mainly constructed during coding and maintenance and used during maintenance. How can the dynamic document system not only support the software maintenance phase, but also provide more support for the software design and development phase? One possible solution is to extend the Software Reuse Technology to include document reuse, including program reuse, program document reuse, and design document reuse, the dynamic document system is also built on the Software Reuse System.