Buscando un artículo en chino e inglés sobre análisis de requisitos de documentación de software. Queridos langostinos, por favor ayúdenme rápido. Gracias. . . .
Muchas empresas han establecido algunos sistemas de gestión informática a gran escala y seguirán lanzando nuevos sistemas. Para satisfacer las necesidades de operación, los sistemas informáticos deben recibir un mantenimiento continuo sin afectar la producción actual. Por lo tanto, se debe establecer un mecanismo para evaluar, controlar y completar el trabajo de mantenimiento del sistema. En el proceso de mantenimiento del software se propone el concepto de unificar programas y documentos, es decir, se crean documentos dinámicos mientras se desarrolla el software.
Proposición del concepto de integración de programas y documentos
1. El estado actual del software
Los programas y documentos están separados, no sólo almacenados en sus propios formatos independientes, sino también escritos y recuperados en diferentes momentos utilizando diferentes herramientas. La documentación no puede ayudar fácilmente al mantenimiento del programa y la documentación no se puede modificar simultáneamente.
Los contenidos de los programas y documentos están separados porque los programas y documentos utilizan diferentes métodos de descripción, tanto en lenguaje informático como en lenguaje natural. Durante el proceso de mantenimiento, los documentos o procedimientos no se pueden actualizar de manera oportuna y consistente, lo que hace que los documentos no puedan describir con precisión los procedimientos, casi se convierten en papel de desecho e incluso aportan valor negativo.
El desarrollo y el mantenimiento del software están separados. La mayoría del software se diseña y desarrolla sin mucha consideración para posibles modificaciones futuras, lo que aumenta la dificultad del mantenimiento del software y facilita la introducción de nuevos errores durante el mantenimiento.
Estas fragmentaciones también se reflejan en la incompatibilidad entre documentos en diferentes etapas de diseño y desarrollo. Por ejemplo: las especificaciones del análisis de requisitos están en papel y no se pueden heredar bien en la etapa de diseño del esquema. Según las instrucciones, la preparación del diseño del esquema debe comenzar desde cero, lo que requiere un nuevo análisis y una comprensión del análisis de requisitos. Esta desconexión en el pensamiento no solo ralentiza el progreso del desarrollo, sino que también aumenta la carga para los diseñadores. Esta desconexión en el pensamiento no sólo ralentiza el progreso del desarrollo y aumenta la carga para los diseñadores, sino que también conduce a muchas incompatibilidades en los objetos descritos en diferentes etapas debido a diferencias en la comprensión. Estas fragmentaciones reducen el papel de la documentación en el diseño, desarrollo y mantenimiento del sistema. Esta es también la razón principal por la que mucho personal de software se muestra reacio a escribir documentación.
En segundo lugar, proponga el concepto de unificar programas y documentos.
¿Qué tipo de sistema documental es un buen sistema documental? Debe tener los siguientes atributos:
1. Ser capaz de describir con precisión el software y ser fácil de entender
2. Ser capaz de localizar errores rápidamente, realizar análisis de impacto y correcciones de diseño;
3. Puede mejorar la calidad del mantenimiento del software;
4. Puede facilitar la comprensión del programa cuando se modifica.
Para ello se propone el concepto de integrar programas y documentos en uno solo. Este concepto hace que el software se convierta en software en el verdadero sentido: programa + documento, programa es documento y documento se integra en el programa. Requiere que al elegir un entorno de desarrollo, no solo se debe considerar el soporte perfecto del entorno para el diseño y el desarrollo, sino también el soporte para el mantenimiento y la documentación; requiere que el personal de software considere los problemas de mantenimiento y documentación durante el proceso de diseño y desarrollo; requiere que los programas y documentos se almacenen en la misma ubicación y en el mismo sistema; requiere el uso de las mismas herramientas para escribir y recuperar programas y documentos; requiere escribir y mantener programas y documentos al mismo tiempo; Requiere documentación al escribir y mantener programas, y escribir y mantener programas al escribir documentación. Los conceptos de procedimientos y documentos existen no solo en las etapas de diseño y desarrollo del sistema, sino también en la etapa de mantenimiento del sistema. Se ejecuta durante todo el ciclo de vida del software.
El sistema de documentos dinámicos es un sistema de documentos en línea simple y fácil de entender basado en el concepto de unificación de programas y documentos, y coherencia de documentos y programas. Incluye descripción de componentes y descripción de datos, descripción de la relación entre componentes y componentes, y componentes y datos. El sistema de documentos dinámico tiene como objetivo mejorar la usabilidad, la facilidad de uso y la coherencia de los documentos, hacer que los documentos sean más efectivos y es una forma eficaz de resolver problemas de mantenimiento.
Análisis de problemas del sistema de documentos dinámicos
Los problemas que deben resolverse incluyen: división de contenido y adquisición de documentos de software, almacenamiento y mantenimiento de documentos, recuperación de documentos y generación e impresión de documentos de software. .
1. El contenido de los documentos de software se divide en: documentos semánticos, documentos estructurales, documentos de proceso.
Los documentos semánticos son descripciones naturales de funciones, conceptos, diseño general, procesos y protocolos del software. , etc. La descripción del lenguaje es un documento de programa escrito y completado por personal de software utilizando herramientas CASE sobre la base de especificaciones. También es un documento explicativo relativamente completo y puede agregar información adicional de manera flexible.
El documento de estructura es una descripción de las herramientas de diseño del software, el entorno de desarrollo, las propiedades de los objetos, las interfaces entre componentes, las referencias entre componentes, la estructura del software, etc. Utilice programas de análisis léxico y sintáctico para identificar y analizar los objetos y componentes de todo el sistema, obtener la descripción anterior y formar un documento formulario.
La documentación del proceso es una descripción del proceso y una descripción del programa formada durante el diseño, codificación y mantenimiento del software, como el propósito del diseño, el diseñador, el tiempo, etc., y utiliza el entorno de desarrollo. Para proporcionar orientación al personal del software durante el diseño y desarrollo, los registros de operación formados durante el proceso de mantenimiento se utilizan para el seguimiento de la operación.
2. Almacenamiento y mantenimiento unificado de programas y documentos
Según el concepto de unificación de programas y documentos, los documentos requeridos extraídos del programa deben almacenarse en el programa, o incluso inherente al documento en el código fuente. El código fuente del programa con esta estructura debe almacenarse utilizando una nueva tecnología: tecnología de almacenamiento de objetos (Repositorio) en lugar de archivos en streaming, de modo que los programas y documentos se combinen y se separen. Los programas y documentos se combinan en un repositorio de objetos y en un entorno de desarrollo unificado; el código combinado puede modificar el documento al mismo tiempo, y el programa se puede verificar y modificar manualmente al mismo tiempo al modificar el documento, y no es así. cambia cuando se generan varios documentos. Los documentos ingresados manualmente se perderán. Los programas y documentos deben almacenarse en diferentes tablas o diferentes campos en el almacén de objetos, separados en tiempo de compilación y ejecución.
En tercer lugar, recuperación de documentos
La recuperación de objetos y componentes individuales en el documento significa que si el documento se almacena en el repositorio de objetos, se puede recuperar y mantener junto con el código fuente. . Esta recuperación proporciona soporte de documentación para analizar y mantener componentes y objetos individuales. Cree múltiples vistas, escriba programas para recuperar y acceder a la documentación de todo el sistema, complete el análisis de todo el sistema y proporcione soporte de documentación en tiempo real para todo el sistema. Esto se detalla en el ejemplo.
4. Generación e impresión de documentos de software
Escribir programas para recuperar y obtener documentos para todo el sistema, crear plantillas de documentos de acuerdo con los estándares de software nacionales y procesar documentos y textos generados. basado en las plantillas Utilice las potentes funciones del software para crear, editar e imprimir documentos.
Con base en el análisis anterior, los requisitos del entorno de desarrollo para la distribución y adquisición de documentos son: el entorno de desarrollo debe ser una integración de herramientas de diseño y herramientas de desarrollo, y debe basarse en la tecnología CASE, almacenamiento de objetos tecnología, tecnología de componentes y tecnología OLE. Un entorno de desarrollo basado en la tecnología CASE; los documentos generados durante los procesos de diseño, desarrollo y mantenimiento están integrados en el código del programa, lo que los convierte en parte del programa. Un entorno de desarrollo basado en tecnología de almacenamiento de objetos almacena documentos y programas en un almacenamiento de objetos para su fácil recuperación. El entorno de desarrollo basado en tecnología de componentes facilita la identificación y adquisición de componentes, el análisis y la formación de documentos estructurales y documentos de proceso. Los documentos basados en tecnologías como OLE hacen un buen uso de software de procesamiento de documentos como Word.
Ejemplos de aplicación de sistemas de documentos dinámicos
El enorme sistema informático de gestión de telecomunicaciones 97 diseñado y desarrollado por Guangzhou Telecom Technology Development Co., Ltd. se utilizará en producción durante mucho tiempo. desde que se puso en producción y aceptación en 1997. El trabajo de mantenimiento es muy importante y urgente. Esto proporciona una necesidad y un lugar para experimentar con sistemas de archivos dinámicos. En el proceso de mantenimiento a largo plazo, la gente se dio cuenta de la importancia de una buena documentación y propuso el concepto de integración de documentos del programa, que proporcionó una base teórica para el sistema de documentos dinámico. El sistema 97 utiliza el entorno de desarrollo Uniface. El entorno de desarrollo utiliza tecnología CASE, tecnología de almacenamiento de objetos y tecnología de componentes para proporcionar soporte técnico para el sistema de documentos dinámico.
1. Pasos para establecer el sistema de documentos dinámicos de Guangzhou Telecom
1. Comprender el entorno de desarrollo de las herramientas Uniface y Oracle, planificar las tablas y campos para el almacenamiento de objetos de documentos semánticos en todos los niveles y completar las reglas de acuerdo con las características. de las herramientas.
2. Encuentre las tablas y campos en las herramientas Uniface y Oracle que almacenan documentos estructurales y documentos de proceso.
3. Rellenar estas tablas o campos según las normas durante el diseño, desarrollo y mantenimiento del software.
4. Establezca un conjunto de plantillas para establecer la imagen de la estructura del documento y las fuentes de información, que incluyen: plantilla de diccionario de datos, plantilla de documento de diseño, plantilla de documento de estructura y plantilla de documento de proceso de desarrollo.
5. Reúna estas plantillas en un sistema de documentos y hágalo independiente del sistema objetivo de desarrollo.
La composición del sistema de documentos dinámicos de Guangzhou Telecom se puede dividir en consulta de documentos, consulta de registros de mantenimiento y generación de documentos.
La consulta de documentos incluye no solo la descripción de los componentes y la descripción de los datos, sino también la descripción de la relación entre los componentes y los datos. Es un sistema de consulta de documentos en línea en tiempo real. La consulta de registro de mantenimiento sirve para registrar y rastrear el proceso de cada enlace en el proceso de mantenimiento del software y se utiliza para estandarizar el trabajo de mantenimiento. Incluye informes de problemas, análisis de problemas, ubicación de errores, diseño de mantenimiento, ejecución de mantenimiento, pruebas de confirmación, revisión de mantenimiento, envío de mantenimiento, seguimiento de problemas, etc. La generación de documentos es la generación en tiempo real de especificaciones de diseño de software según sea necesario.
2. El concepto de unificar programas y documentos y la importancia de los sistemas de documentos dinámicos
Las tareas básicas del sistema de documentos dinámicos de Guangzhou Telecom son ayudar en la localización de errores, el análisis del impacto del mantenimiento, y registrar los procesos de mantenimiento. Generar documentación. El sistema se desarrolla utilizando el entorno de desarrollo Uniface y se puede instalar en diferentes sistemas de aplicaciones desarrollados con Uniface. Este sistema ha desempeñado un papel importante en el mantenimiento del sistema de facturación de 1997.
Aboga por el concepto de integración de programas y documentos, proponiendo que los documentos son programas, los programas son documentos y la integración de documentos se concibe e implementa en los programas. Este concepto guía al personal de software a realizar su trabajo de manera efectiva. . El concepto unificado recorre todo el ciclo de diseño, desarrollo y mantenimiento del software, asegurando la herencia y coherencia entre documentos. Cada etapa de diseño y desarrollo es el resultado de heredar los programas y documentos de la etapa anterior. Esto elimina en gran medida la inconsistencia entre programas y documentos, documentos y documentos, acelera el progreso del diseño de software y mejora la calidad del desarrollo y mantenimiento del software. Es un intento de ingeniería de software en aplicaciones específicas y estandariza aún más el diseño, desarrollo y mantenimiento de software desde la perspectiva de la documentación unificada del programa. El concepto de unificación de documentos de programa proporciona una idea para el desarrollo de un entorno de desarrollo de software; se diseña un mejor almacén de objetos basado en el concepto de unificación de documentos de programa para satisfacer las necesidades del personal de desarrollo y mantenimiento.
Limitaciones y desarrollo de sistemas de documentos dinámicos
El sistema de documentos dinámicos de Guangzhou Telecom tiene grandes limitaciones y solo puede usarse en sistemas desarrollados por Uniface u Oracle. En la actualidad, la identificación y adquisición de componentes del sistema de documentos dinámicos de Guangzhou Telecom se basa principalmente en la identificación de componentes y las características de los componentes proporcionadas por las herramientas de desarrollo. Este tipo de sistema de documentos dinámico es difícil de unificar y separar programas y documentos en algunas herramientas 3GL: software desarrollado sin tecnología de almacenamiento de objetos ni tecnología de componentes. El entorno de los sistemas de software a gran escala es complejo y a menudo se utilizan múltiples entornos de desarrollo. Aún queda por explorar a través de la tecnología y la práctica cómo soportar otros entornos de desarrollo.
Otra limitación es que los documentos del programa descritos por el sistema de documentos dinámico actual se construyen principalmente en el proceso de codificación y mantenimiento, y solo se pueden utilizar cuando el sistema ingresa a la etapa de mantenimiento. ¿Cómo hacer que el sistema documental dinámico no solo respalde la fase de mantenimiento del software, sino también la fase de diseño y desarrollo del software? Una solución factible es extender la tecnología de reutilización de software a la reutilización de documentos, incluida la reutilización de programas, la reutilización de documentos de programa y la reutilización de documentos de diseño, y el sistema de documentos dinámico se construye en el sistema basado en esta tecnología de reutilización de software.