Ett erkänt problem inom industrin för mjukvaruutveckling är bristen på kvalitativ systemdokumentation. Hos företaget Multisoft Consulting finns detta problem. Utvecklare måste spendera onödigt mycket tid på att sätta sig in i befintliga system. Som en del av lösningen vill företaget införa automatisk generering av dokumentation. Genereringen ska ske i plattformen Softadmin® som används för att bygga alla kundsystem. Plattformen är baserad på C# och Microsofts SQL Server och innehåller en mängd färdiga komponenter med olika funktionalitet. För att veta vilken dokumentation som bör genereras automatiskt har litteraturstu-dier och intervjuer med Multisoft Consulting-anställda genomförts. För att veta vilken dokumentation som kan genereras har Softadmin® analyserats. Undersökningarna visar att dokumentation som ger en överblick över ett system samt visar hur systemet används både är önskvärd och möjlig att generera via Softadmin®. En form av system-överblick fanns redan implementerad i Softadmin® i form av en träd-struktur. Överblicken saknade dock en del önskvärda detaljer vilket medförde att fokus för studien blev att implementera en prototyp som kompletterade överblicken. Resultatet är att information om systemets menyval, vilket är sidor med olika funktionalitet, nu visas i överblicken. / A well-known problem within the software development industry is the absence of qualitative system documentation. This problem can be found within the company Multisoft Consulting. Too much time is spent by the developers when they must familiarize themselves with an existing system. As a part of the solution to this problem the company would like to generate documentation automatically. The generation should be performed by the platform Softadmin® which is used to develop all customer systems. The platform is based on C# and Microsoft’s SQL Server and contains different components, each with its own functionality. In order to find out which documentation that should be generated automatically literature has been studied and developers have been interviewed. In order to know which documentation that can be generated by Softadmin® the platform has been analyzed. The conclusion is that documentation which provides a general view of the system and demonstrates how the system is used is both desirable and possible to generate with Softadmin®. A kind of general view had already been implemented in Softadmin®. However, some desired features were not included in the general view. The priority of this study became to implement a prototype which completed the general view by including some of the desired features. The result is that it is now possible to display information about the system’s menu items, which is pages with different functionality, within the general view.

No description available.

Developers of reusable software elements, such as libraries, usually have the responsibility to provide comprehensive and high quality documentation to enable eective reuse of those elements. The eective reuse of libraries depends upon the quality of the API (Application Program Interface) documentation. Well established libraries typically have comprehensive API documentation, for example in Javadocs. However, they also typically lack examples and explanations, which may dicult the eective reuse of the library. StackOverow.com (SO) is a Question and Answer service directed to issues related to software development. In SO, a developer can post questions related to a programming topic and other members of the site can provide answers to help him/her solve the problem he/she has at hand. Despite of the increasing use of SO by the software development community, the information related to a particular library is spread along the website. Thus, SO still lacks an organization of its crowd knowledge. In this dissertation, we present a semi-automatic approach that organizes the information available on SO in order to build a kind of documentation for APIs, called cookbooks (recipe-oriented books). The cookbooks generated by the approach are called crowd cookbooks. In order to evaluate the proposed approach, cookbooks were generated for three APIs widely used by the software development community: SWT,LINQ and QT. Desired features that cookbooks must meet were identied and a study with human subjects was conducted to assess to what extent the generated cookbook meet those features. Through the study it was also possible to identify what is the perceived usefulness by the subjects in relation to the use of cookbooks in APIs learning. The results showed that the cookbooks built using the proposed strategy, in general, meet the identied features. Furthermore, most human subjects considered that cookbooks do not have an appropriate format to the learning of APIs. / Desenvolvedores de elementos reusáveis de software, como as bibliotecas, em geral têm a responsabilidade de disponibilizar documentação abrangente e de alta qualidade para permitir o reuso efetivo desses elementos. O reuso efetivo de bibliotecas depende da qualidade da documentação da API (Interface para Programação de Aplicativos). Bibliotecas bem estabelecidas tipicamente têm documentação abrangente, por exemplo em Javadocs. Porém, essa documentação geralmente carece de exemplos e explicações, o que pode dicultar o reuso efetivo da biblioteca. Stackoverow.com (SO) é um serviço de perguntas e respostas (Q&A) direcionado a questões relacionadas ao desenvolvimento de software. No SO, um desenvolvedor pode postar perguntas relacionadas a um tópico de programação e outros membros do site podem disponibilizar respostas para ajudá-lo a resolver o problema que ele tem em mãos. Apesar da utilização crescente do SO pela comunidade de desenvolvimento de software, a informação relação a um biblioteca está espalhada ao longo do site. Assim, o SO ainda carece de uma organização do crowd knowledge nele contido. Nessa dissertação, será apresentada uma abordagem semi-automatizada que organiza a informação disponível no SO para a construção de um tipo de documentação para APIs, conhecido por cookbooks (livros orientados a receitas). Os cookbooks produzidos pela abordagem proposta são chamados crowd cookbooks. Para avaliar a abordagem proposta foram gerados cookbooks para três APIs amplamente utilizadas pela comunidade de desenvolvimento de software: SWT, LINQ e QT. Foram identicadas características desejáveis de cookbooks e realizado um estudo com sujeitos humanos para entender em que grau os cookbooks construídos atendem a estas características. Por meio estudo também foi possível compreender melhor os pers de uso dos cookbooks mais apropriados em relação ao aprendizado de APIs. Os resultados mostraram que os cookbooks construídos pela estratégia proposta, em geral, atendem às características identicadas. Além disso, a maior parte dos sujeitos humanos considerou que cookbooks não possuem um formato adequado ao aprendizado de APIs. / Mestre em Ciência da Computação

Made available in DSpace on 2016-12-23T14:33:43Z (GMT). No. of bitstreams: 1 Dissertacao Lucas de Oliveira Arantes.pdf: 2264655 bytes, checksum: 67cdb0cba1670e3d591848c2ebb8e7fc (MD5) Previous issue date: 2010-08-27 / Documentos são mecanismos importantes para registro e disseminação de conhecimento e comunicação entre seres humanos. Organizações de software contam com esse mecanismo para a realização de projetos. Essas organizações, quando maduras, definem uma série de modelos de documento de software para apoiar o processo de documentação. Adicionalmente, as mesmas contam com processos e mecanismos para registrar o histórico evolutivo dos documentos envolvidos em um projeto. A quantidade de documentos gerados durante o ciclo de vida de um projeto de software pode ser consideravelmente grande. Apesar dos sistemas de controle de versão facilitarem o controle da evolução dos documentos, os mesmos não são capazes de apoiar a integração e a visualização objetiva de suas informações. Somado a isso, documentos são normalmente tratados como um mero conjunto de caracteres com estilos de formatação voltados para renderização em ferramentas de edição de texto (em inglês, document authoring tool). Neste contexto, a adição de metadados baseados em ontologias de domínio apoia o desenvolvimento de documentos semânticos que podem ser utilizados para contornar esse cenário. O processo de anotação semântica de documentos, quando feito de forma manual, é enfadonho e suscetível a erros. O uso de modelos de documento com anotações semânticas é uma opção viável para a automatização parcial desse processo. Assim, a união de mecanismos de integração contidos em sistemas de controle de versão e modelos de documento de software semanticamente anotados é um meio potencial de apoiar a integração de informações e, por conseguinte, a execução de projetos de software. Esta dissertação trata da utilização de modelos de documento de software anotados semanticamente e mecanismos de controle de versão para registrar a evolução do conteúdo semântico existente em documentos gerados e para prover serviços de integração e visibilidade dos dados relativos aos documentos. Para tal, uma Plataforma para Gerenciamento de Documentos Semânticos é definida / Documents are important mechanisms to register and disseminate knowledge and allow communication between human beings. Software Organizations use this mechanism to conduct projects. When these organizations reach a certain level of maturity they tend to use software document models in order to support the documentation process. Additionally, organizations count on processes and mechanisms to track the evolution of documents involved in a project. The amount of documents produced during a software project lifecycle can be considerably large. Despite the fact that version control systems support document centralization they are not capable of support information integration and visibility. Summing up, documents are treated as a set of characters tied with formatting styles because their primary goal is to be well rendered on a document authoring tool. In this context, adding domain ontology based metadata can help developing semantic documents, which, in turn, can help overcoming this scenario. Manual Semantic Annotation is notably dull and error prone. Combining document models semantic annotation is a viable option in order to achieve the annotation process automatization. Thus, uniting integration mechanisms provided by version control systems and software document models semantically annotated is a potential way of supporting information integration and, therefore, executing software projects. This work treats the use of software document models annotated semantically and version control mechanisms to track and register the evolution of a semantic document content (instantiated from a semantic model) and the provision of data visibility and integration services. In this sense, a Platform for Managing Semantic Documents is defined