寻找一篇软件文档需求分析的文章，要英汉对照。各位大虾请速度帮忙谢谢啊。。。。
发布网友
发布时间：2022-04-30 02:25
共2个回答
热心网友
时间：2023-10-05 14:53
很多企业已经建立了许多庞大的计算机管理系统，而且将不断地推出新的系统。满足经营的需求须不断维护、改造计算机系统，但同时又要不影响现行生产，所以必须建立一整套机制来评价、控制和完成对系统的维护。在软件维护过程中，提出程序与文档合一的概念在软件开发的同时建立动态文档。
程序与文档合一概念的提出
一、目前软件的状况
程序与文档的形式分离，不仅是用各自独立的形式存放，而且使用不同的工具在不同的时间里书写和检索。维护程序时不能方便地得到文档的帮助，不能同步修改文档。
程序与文档的内容分离，由于程序与文档采用不同的描述，既有计算机语言也有自然语言。维护过程中不能及时、一致地更新文档或程序，使文档不能准确地描述程序而几乎成为废纸甚至带来负面价值。
软件开发与维护的分离，绝大多数软件在设计、开发时不太考虑以后可能的修改，加大了软件维护的难度，而且使维护容易引入新的错误。
这些分离也表现在设计、开发的不同阶段的文档之间的不相容性，例如：需求分析说明书是纸上的东西，在概要设计阶段不能很好地继承、利用需求分析说明书，设计、编制概要设计时必须从零开始，需要重新分析、理解需求分析，这种思维上的脱节，不仅延缓开发进度、加重设计人员的负担，而且由于理解上的不同导致不同阶段描述的对象有许多不相容情况。这些分离使得文档在系统的设计、开发、维护中的作用下降，这也是很多软件人员不愿意编写文档的主要原因。
二、程序与文档合一的概念提出
怎样才是好的文档系统呢？应当具备以下属性：
1. 能够准确地描述软件、并且简单易懂；
2. 能够迅速错误定位、影响分析、修正设计；
3. 能够提高软件维护质量；
4. 能够方便程序修改时理解程序。
为此提出了程序与文档合一的概念。这概念使软件成为真正意义上的软件：程序+文档，程序就是文档，文档集成在程序中。它要求在选择开发环境时不仅要考虑环境对设计、开发的完美支持，而且要考虑对维护、文档的支持；它要求软件人员在设计、开发过程中要考虑维护问题、文档问题；它要求程序与文档存储在同一位置、同一系统中；它要求使用相同工具进行程序与文档的书写、检索；它要求在编写和维护程序的同时形成文档，在书写文档时编写、维护程序。程序与文档合一的概念不仅存在于系统的设计、开发阶段而且存在于系统的维护阶段，它贯穿软件的生命周期。
动态文档系统是建立在程序与文档合一的概念基础上的、文档与程序一致的、简单易懂的联机文档系统。它包括构件说明与数据描述、对构件与构件之间、构件与数据之间的关系进行的描述。动态文档系统是提高了文档的可用性、易用性和连贯性，使文档更加有效，是解决维护问题的有效途径。
动态文档系统问题分析
需要解决的问题是：软件文档的内容划分与获取、文档的存储与维护、文档的检索、软件文档的生成打印。
一、软件文档的内容划分成：语义文档、结构文档、过程文档
语义文档是对软件的功能、概念、总体设计、流程、规约等用自然语言的描述，是软件人员根据规范在使用CASE工具编写并填入程序的文档，它也是为更全面的解释文档而灵活加入的额外信息。
结构文档是在软件设计工具、开发环境中对象的属性、构件间接口、构件间引用关系、软件的结构等的描述。利用词法、语法分析程序对整个系统的对象、构件进行识别、分析，获取上述描述并形成表格文件。
过程文档是对软件的设计、编码、维护过程中形成的过程描述和程序注释，如设计目的、设计人、时间等说明，利用开发环境对软件人员在设计、开发、维护过程中操作的记录形成操作跟踪。
二、程序与文档的统一存储与维护
根据程序与文档合一的概念和文档从程序中提取的要求，文档必须存放在程序中，甚至文档固有的源代码中。结构如此的程序源代码的存储必须采用一种新技术—对象仓储（Repository）技术，而不能采用流式文件，这样才能使程序与文档既结合又分离。程序与文档结合在一个对象仓储中，结合在统一的开发环境中；结合在修改代码时可以同时修改文档、修改文档时可以同时人工检查和修改程序，并在多次文档生成而不会丢失手工输入的文档。程序与文档应当分别存放在对象仓储中的不同表或不同的字段中，在编译与运行时分离。
三、文档的检索
对单个对象、构件文档的检索方式是若于文档存放在一个对象仓储中，它可以随源代码一起检索和维护。这种检索给分析和维护单个构件、对象提供文档支持。建立多种视图、编写程序对整个系统进行文档的检索和获取，完成对整个系统的分析，对整个系统进行实时文档支持。这将在例子中较详细的描述。
四、软件文档的生成打印
编写程序检索和获取整个系统的文档，按照国家软件标准的文档式样建立文档模板并将按模板生成文档和利用文字处理软件强大的功能进行创建、编辑文档并打印。
根据上述分析，文档分布和获取对开发环境提出了要求：开发环境应该是设计工具、开发工具的集成，应该基于CASE技术、对象仓储技术、构件技术、OLE技术。基于CASE技术的开发环境；设计、开发、维护过程中形成的文档并植入程序代码中，使文档成为程序的一部分。基于对象仓储技术的开发环境，将文档与程序统一存储在对象仓储中方便检索。基于构件技术的开发环境，便于识别、获取构件，分析、形成结构文档和过程文档。基于OLE等技术使文档可以很好地利用Word等文档处理软件。
动态文档系统的一个应用实例
广州电信科技开发有限公司自行设计、开发的名为九七系统的庞大的电信管理计算机系统自1997年投产验收后，将长期用于生产，维护工作非常重要和紧迫。这为动态文档系统提供了需求和试验场所。在长期维护的过程中，体会到好文档的重要性并提出了程序文档合一的概念，这为动态文档系统提供了理论基础。九七系统是使用Uniface开发环境。这种开发环境采用了CASE技术、对象仓储技术、构件技术，这为动态文档系统提供了技术支撑。
一、广州电信动态文档系统的建立步骤
1. 理解Uniface、Oracle工具的开发环境，规划语义文档在各级对象中存放的表与字段，并根据工具的特性制定填写的规则。
2. 寻找结构文档、过程文档在Uniface、Oracle工具中存放的表与字段。
3. 在设计、开发和维护软件的过程中对这些表或字段按照规则进行填写。
4. 建立一整套模板使文档结构与信息源建立映像，包括：数据字典模板、设计文档模板、结构文档模板、开发过程文档模板等。
5. 将这些模板组装成文档系统，并使它独立于开发目标系统。
广州电信动态文档系统的组成可以分为文档查询、维护记录查询、文档生成。
文档查询不仅包括构件说明与数据描述，而且包括对构件与数据之间的关系的描述，是实时的联机文档查询系统。维护记录查询是对软件维护过程中的各个环节进程进行记录与追踪，用于规范维护工作。它包括问题报告、问题分析、错误定位、维护设计、维护执行、确认测试、维护评审、维护提交、问题跟踪等。文档生成则是根据需要实时生成软件设计说明书。
二、程序与文档合一概念与动态文档系统的意义
广州电信动态文档系统的基本任务是辅助错误定位、维护影响分析、记录维护进程、生成文档。使用Uniface的开发环境开发的，可以安装在用Uniface开发的不同的应用系统中。该系统已经在九七计费系统的维护中发挥重要作用。
它推崇的程序与文档合一的概念，提出文档就是程序，程序就是文档的思路，文档融合在程序中的构思并已实现，这一概念指导了软件人员进行有效地工作。合一的概念贯穿了设计、开发、维护整个软件周期，保证了文档之间的继承性和一致性，在设计、开发每一阶段是继承前阶段的程序和文档的结果。这样极大地消除了程序与文档、文档与文档之间的不一致性，加快了软件设计进度，提高了软件开发、维护的质量。它是软件工程在具体应用中的一种尝试，它从程序文档合一的角度出发，进一步规范软件设计、开发、维护。程序文档合一的概念为软件开发环境发展提供了一种思路；设计更好的对象仓储来满足开发、维护人员对程序文档合一的概念的需求。
动态文档系统的局限与发展
广州电信动态文档系统有很大的局限性，只能用于Uniface或Oracle开发的系统中。目前的广州电信动态文档系统的构件的识别与获取主要依赖开发工具提供的构件和构件的特征进行识别的。这种动态文档系统难以在一些3GL工具—未使用对象仓储技术、构件技术开发的软件—中实现程序与文档的合一与分离。大型软件系统的环境是复杂的，往往采用了多种开发环境，如何对其他开发环境进行支持还要进行技术探讨和实践上的摸索。
另一个局限问题是目前的动态文档系统描述的是程序文档，其主要在编码、维护的过程中进行建设，系统进入维护阶段使用。如何使动态文档系统不仅对软件维护阶段进行支持，而且对软件的设计、开发阶段进行更多的支持？一种可能的解决途径是将软件复用技术拓宽到包括文档复用，包括程序复用、程序文档复用和设计文档复用，而且将动态文档系统建立在基于这种软件复用系统之上。
热心网友
时间：2023-10-05 14:54
Many enterprises have been established in many large computer management systems, and will continue to introce new systems. Meet the needs of operators must continuously maintain and transform the computer system, but at the same time do not affect the existing proction, it is necessary to establish a set of mechanisms to assess, control and the maintenance of the system completed. Software maintenance in the process, proceres and documentation to the concept of unity in the development of software in addition to establishing a dynamic document.
Proceres and documentation to the concept of unity
First, the current state of software
Proceres and documentation in the form of separation is not only used in the form of separate storage, and use different tools at different times in writing and retrieval. Maintenance proceres can not be easily with the help of documents and can not modify a document simultaneously.
Proceres and documents from the content, proceres and documentation as a different description of the existing computer languages also have natural language. In the process of maintaining timely and consistent updating documents or proceres, so that documents can not be accurately described proceres become almost a negative value or even waste paper.
Software development and maintenance of the separation, the vast majority of software in the design, development, the future is unlikely to consider possible changes, and increased the difficulty of maintaining software, but also to safeguard the introction of a new easy wrong.
These separation performance in the design, development of the different stages of the incompatibility between documents, such as: needs analysis is the specification of the things on paper, in the outline design stage can not be inherited, using brochures needs analysis, design, preparation Summary of the design must start from scratch, need to re-analysis, understanding needs analysis, this line of thinking, not only retard development, and add to the burden of design staff, and because of the different understanding of the different stages led to a description of many of the targets Vice situation. Separation makes these documents in the system design, development, and safeguarding the role of decline, this is a lot of software staff to prepare the main document.
Second, proceres and documents the concept of unity
What is Documentation? Should have the following properties:
1. Be able to accurately describe software, and easy-to-understand;
2. Prompt wrong positioning, impact analysis, that design;
3. To improve the quality of software maintenance;
4. Easily understood proceres for amending the proceres.
In this paper, proceres and the concept of unity document. This concept of the software become a true sense of the software: + documentation proceres, and proceres is documentation, documentation, integrated in the process. It demands the choice of development environment, we must not only consider the environment on the design, development, the perfect support, but also to consider the maintenance, documentation to support its request in software design, development process, we need to consider maintenance issues, documentation issues; it proceres and document storage requirements in the same position, the same system; its request to use the same proceres and tools for writing documents, retrieval; It requires the preparation and maintenance proceres at the same time a document, in writing, document preparation, maintenance proceres. Document proceres and the concept of unity not only exists in the system design and development phase exists in system maintenance stage, it runs through the software life cycle.
Dynamic file system is built on the proceres and documentation based on the concept of integration, documentation and proceres consistent, easy-to-understand on-line documentation system. It includes the components and descriptions of data between the component and components, component of the relationship between the data and a description. Dynamic file system is to improve the availability of the documentation, ease of use and consistency of the documents more effectively is to solve the problem of maintaining an effective way.
Dynamic document analysis system
Need to address the question is: software documentation and the content of the acquisition, storage and maintenance of documents, document retrieval, document proction printing software.
First, the content of software documentation divided into: semantic document, document structure, process documents
Semantic document is the function of the software, concept, design, process, such as the Statute of using natural language description of the software personnel in accordance with norms in the use of CASE tools fill proceres and the preparation of the document, it is also for a more comprehensive explanation of the text Files and flexible by adding additional information.
Documents in the structure of software design tools, development environment in the object's properties, component Interface, cited relations between components, software such as a description of the structure. Use lexical, grammatical analysis program on the subject of the whole system, component identification, analysis, and to obtain the above description of a form document.
Documentation of the process of software design, coding, developed in the course of maintaining the process and proceres described Notes, as designed, design, time that the use of the software development environment in the design, development, operation of the process of maintaining the records a tracking operation.
Second, the unification of proceres and document storage and maintenance
Proceres and documentation in accordance with the concept of unity and the process of extracting documents from the request, documents must be stored in the proceedings, and even documents inherent in the source code. Such a structure of the source code must adopt a new storage technology - Target storage (Repository) technology, and not with streaming documents, in order to combine both proceres and documentation and separation. Proceres and documentation with an object in the warehouse, with a unified development environment in conjunction with the revised code can be modified files, documents can be amended at the same time artificial inspect and modify proceres, and in many document generation without be lost manual input documents. Proceres and documentation should be stored in the object storage respectively in the different forms or different fields, in the compiler and run-time separation.
Third, document retrieval
On the single object, component document retrieval methods is that if the object files stored in a warehouse, it can be retrieved together with the source code and maintenance. This analysis and retrieval to the maintenance of indivial components, objects provide document support. The establishment of a variety of views, the entire procere to prepare the system for document retrieval and access, completion of the analysis of the whole system, the entire file system for real-time support. This example will be described in more detail.
Fourth, document generation software Print
Search proceres for the preparation of the whole system and access to documents, in accordance with national standards of software design documents on the establishment of document templates and template files generated using word processing software and powerful features to create, edit and print documents.
Based on the foregoing analysis, document distribution and access to the development environment proposed requirements: development environment should design tools, development tools integration, should be based on the CASE technology, object storage technology, component technology, OLE technology. CASE technology-based development environment, design, development, maintenance documentation developed in the course of implantation proceres and code, so that documents become part of the process. Object-based storage technology development environment, documentation and proceres will be stored in the object storage reunification easily retrieved. Based on component technology development environment, facilitate the identification, acquisition components, analysis, documentation and structure formation process documents. Based on the OLE technology that can make good use of documents such as Word document-processing software.
Dynamic file system an example of application
Guangzhou Telecom Technology Development Co., Ltd. to design, development, called the 97 large telecommunications management computer system since 1997 commissioning acceptance, it will be a long time for the proction, maintenance work is very important and urgent. This document provides a dynamic demand and test sites. In the process of long-term maintenance, and learn about the importance of good documentation and proceres document put forward the concept of unity, this system is dynamic document provides a theoretical basis. 97 is the use of Uniface development environment. This development environment using the CASE technology, object storage technology, component technology, this system is dynamic document provided technical support.
1, Guangzhou telecommunications system for dynamic document steps
1. Understanding Uniface, Oracle development tools environment, planning documents at all levels of semantic objects stored in the table and field, and in accordance with the characteristics of the development tools fill in the rules.
2. Find structure documents, process documents in Uniface, Oracle stored in the table tool and field.
3. In the design, development and maintenance of software in the course of these fields or in accordance with the table rules complete.
4. Establishment of a set of templates to document structure and the establishment of image sources of information, including: data dictionary template design document template, template file structure, the development process, such as document templates.
5. These templates will be assembled into document systems, and to make it independent of the development of the target system.
Guangzhou Telecom dynamic document systems can be divided into components for documentation, maintenance records enquiries, document generation.
Documentation for components that include not only with the data description, and includes data on the components and the relationship between the description, is a real-time online document search system. Maintenance records for the software maintenance of the various links in the process of recording and tracking process for standardizing maintenance. It includes reports, the problem of the wrong positioning, maintaining design, implementation, validation testing, and maintenance assessment, and safeguarding the problem tracking. Document generation is the generation needed real-time software design specification.
Second, the concept of unity proceres and documentation system with dynamic document the significance of
Guangzhou Telecom dynamic document system is the basic mission of supporting the wrong positioning, maintaining impact analysis, record keeping process, generate documentation. Using Uniface development environment developed that can be installed using Uniface development of the different application systems. The system has been in 1997 in the billing system maintenance play an important role.
It praises of the proceres and the concept of unity of the document, document is the proposed proceres, proceres that the idea of documents, documents in the integration process and the idea has been achieved, the concept of stewardship of the software staff to work effectively. The concept of unity through the design, development and maintenance of the entire cycle of software to ensure that the file between the succession and consistency in the design, development, before each stage is the stage of the succession process and the outcome document. This greatly eliminate the proceres and documentation, documentation and documentation inconsistencies between the pace of software design, and enhance their software development, maintenance quality. It is the specific application of software engineering in an attempt to document its proceres from the point of view of unity, and further regulate the software design, development, maintenance. One document proceres for the concept of the development of software development environment provides a concept designed to better meet the target of warehousing development, maintenance personnel file of the proceedings of the concept of integration needs.
Dynamic file system and the limitations of development
Guangzhou Telecom dynamic document systems have serious limitations, or can only be used to Uniface development of the Oracle system. Guangzhou Telecom current dynamic document identification system components and access to rely mainly on the development of tools to provide components and component characteristics identifiable. This dynamic file system difficult in a number of 3 GL tools - No use of object storage technology, development of the software component technology - proceres and documentation to achieve unity and separation. Large software systems environment is a complex, often using a variety of development environments, how to support other development environment to conct a technical study and practice of exploration.
Another problem is that of the current limitations of dynamic document systems described in a proceral document, mainly in the coding, maintenance of the construction process, the system used to enter maintenance phases. How to make the system not only to the dynamic document software maintenance phase support, and the software design, development stage for more support? A possible solution is to expand to include Software Reuse document reuse, including proceres for reuse, reuse process documentation and design files multiplexing, dynamic document and will be set up in the system based on this software reuse on the system used.
