Informações:

Publicações do PESC

Título
SIM: Um Gerador Semi-Automático de Documentos
Linha de pesquisa
Engenharia de Software
Tipo de publicação
Dissertação de Mestrado
Número de registro
Data da defesa
18/3/1992
Resumo

Manuais de produtos de software são, geralmente, elaborados na fase final de projeto, após a implementação do sistema ou, mesmo, durante a vida útil do software. Assim sendo, esses manuais apresentam, muitas vezes, inconsistências pois modificações no código implicam em atualizações dos documentos, tarefa que é frequentemente esquecida. Em ambientes científicos, aonde são numerosas as mudanças em um software, esse problema se torna ainda mais crítico.

Este trabalho apresenta a ferramenta SIM, que gerencia as informações de produtos de software de forma a produzir seus respectivos manuais de utilização, de uma forma semi-automática.

A construção de SIM envolveu pesquisas sobre tipos de documentação, produção de documentos e desenvolvimento de software científico. Diversas técnicas e idéias para geração de documentos foram reunidas definindo uma metodologia, que focaliza a introdução da qualidade na documentação, implementada na ferramenta SIM.

SIM trata o problema da existência de inconsistências entre o código e sua documentação extraindo informações diretamente do arquivo-fonte e integrando as atividades de codificação e elaboração da documentação do software em um mesmo ambiente.

A ferramenta oferece roteiros para documentação, os quais podem ser adaptados à aplicação em desenvolvimento, e permite uma abstração sobre o formato dos manuais, desde que o conteúdo é manipulado separadamente do layout do documento. Através desse esquema de roteiros, SIM torna possível a produção de documentos em uma forma padrão.

SIM foi implementado no CERN, em Genebra, no contexto do Projeto de Colaboração UFRJ/CERN. Tinha-se, portanto, um ambiente científico e foram consideradas suas características particulares no que diz respeito ao desenvolvimento de software, tais como: carência de especificações e projeto, desenvolvimento incremental, manipulação de grande quantidade de dados e tendência a sofrer várias modificações e adaptações.

Abstract

Software manuals are usually produced at the end of the design phase, after the system implementation or even during the operational life. Because of that, most of the documents have inconsistencies since code modification implies the updating of the documents, what is frequently forgotten. In a scientific environment, where computing processes need numerous changes, the task of ~rovidingw ritten information is even more critical.

This work introduces the SIM software, which manages software information in order to produce the users manuals, in a semi-automatic way.

The implement ation involved research about document ation types , document production and scientific software development. Severa1 techniques and ideas about the document generation were brought together, defining a methodology, supported by SIM, focusing the production of document ation with quality.

SIM deals with the problem of inconsistencies between code and documentation by extracting information directly from the source code, and by integrating the code implementation and the document generation activities in an unique environment.

This system provides guidelines for building up software documentation that can be customized to the application requirements. Within this system the user has an abstraction over typesetting details of the final documents, since the content and the format of the manuals are handled separately. Through a guideline approach, SIM makes possible the documents production in a standard way.

SIM was implemented at CERN2, in Geneva, within the Collaboration Project between UFRJ and CERN. There was, therefore, a scientific environment and its characteristics concerning software development were taken into account, such as: lack of specificat ions and pro j ect definition, increment a1 development , manipulation of large amounts of data and a tendency of suffering severa1 modifications and adaptations.

 

Arquivo
Topo