Software documentation

From WikiPapers
Jump to: navigation, search

Software documentation is included as keyword or extra keyword in 0 datasets, 0 tools and 6 publications.

Datasets

There is no datasets for this keyword.

Tools

There is no tools for this keyword.


Publications

Title Author(s) Published in Language DateThis property is a special property in this wiki. Abstract R C
QuoDocs: Improving developer engagement in software documentation through gamification Sukale R.
Pfaff M.S.
Conference on Human Factors in Computing Systems - Proceedings English 2014 Open source projects are created and maintained by developers who are distributed across the globe. As projects become larger, a developer's knowledge of a project's conceptual model becomes specialized. When new members join a project, it is difficult for them to understand the reasoning behind the structure and organization of the project since they do not have access to earlier discussions. We interviewed and surveyed developers from a popular open source project hosting website to find out how they maintain documentation and communicate the project details with new members. We found that documentation is largely out of sync with code and that developers do not find maintaining it to be an engaging activity. In this paper, we propose a new system - QuoDocs - and take a human-centered approach to introduce competitiveness and personalization to engage software developers in documenting their projects. 0 0
Documenting software using adaptive software artifacts Correia F.F. SPLASH 2013 - Proceedings of the 2013 Companion Publication for Conference on Systems, Programming, and Applications: Software for Humanity English 2013 Creating and using software documentation presents numerous challenges, namely in what concerns the expression of knowledge structures, consistency maintenance and classification. Adaptive Software Artifacts is a flexible approach to expressing structured contents that tackles these concerns, and that is being realized in the context of a Software Forge. Copyright © 2013 by the Association for Computing Machinery, Inc. (ACM). 0 0
Annotating software documentation in semantic wikis Klaas Andries de Graaf ESAIR English 2011 0 0
SaaS support in software documentation systems Stepalina E. 2010 6th Central and Eastern European Software Engineering Conference, CEE-SECR 2010 Russian 2010 In recent days more and more software developments tools become distributed by the SaaS (Software-As-A-Service) model alongside with ready-to-install products. The developers of task and bug tracking systems now offer their solutions by a monthly fee. For instance, JIRA Studio produced by Atlassian can be connected to a corporative domain by subscription. This scheme allows software companies to reduce costs at the project's start and get scalable resources in future. Software documentation systems can also be purchased by a subscription now. The effectiveness of their usage for various documentation development is interesting. There are four major types of documentation supporting the development process and resulted products: project, technical, code and user documentation. Each of this type claims specific requirements for the documentation tool. The requirement analysis shows that rented documentation systems are the most appropriate for user and technical documentation. There are two major classes of software documentation systems: • Wiki, • DITA-oriented XML CMS. The following wiki systems have a hosted version: commercial - Confluence, Central Desktop, EditMe, Incentive, Netcipia, PBWiki, Wikia, Wikispaces; open source - BusinessWiki, Metadot Wiki, MindTouch, Wagn, Wikidot. The richest by the functionality and plugin collection is Confluence produced by Atlassian. The following XML CMS are offered by a SaaS model (all are commercial): Astoria On Demand, DITA Exchange. DocZone. SaaS is optionally supported in Bluestream XDocs, Siberlogic SiberSafe, Trisoft Infoshare, Vasont, X-Hive Docato. As wiki system is a ready integrated environment for creating and publishing documentation, DITA-system consists not only of XML CMS. To deploy a DITA-system, you should have an XML editor, publisher and CMS. The listed CMS can be integrated with top DITA XML editors and provide an API to integrate with other editors. These CMS also have build-in tools to export documents in multiple formats. However, the universal component architecture of DITA-systems makes the deployment and configuration more difficult than wiki implementation. Hosted documentation systems are offered by different prices. The offerings of top documentation systems are considered in this paper. Wiki subscription fees range from 4,95$ (EditMe) to 20$ (Confluence) per one user/month. XML CMS subscription price starts from 500$ per month and can reach 12000$ per month. These subscriptions have no fixed price; in each individual case the CMS vendor performs a specific project of a DITA-system implementation. Wiki rental costs approximate to CMS subscriptions' costs for large number of users, 500 and more.The advantages of renting a powerful documentation system for small and large project are the following: • Maximal functionality at a low affordable cost, • Platform independency and high system accessibility, • Document quality improvement at the expense of quality controlling tools application, • Higher effectiveness of documentation (content re-use, single source usage, automated tools for localization), • Organization of robust and scalable documentation process. As the SaaS business model becomes more popular, small companies get access to powerful software documentation systems, which are too expensive to purchase a standalone license at the startup. However, the system's access security, reliability and information confidentiality issues remain opened and controversial. 0 0
WikiWiki Weaving Heterogeneous Software Artifacts Ademar Aguiar
Gabriel David
WikiSym English 2005 Good documentation benefits every software development project, especially large ones, but it can be hard, costly, and tiresome to produce when not supported by appropriate tools and methods. The documentation of a software system uses different artifacts, namely source code, for low-level internal documentation, and specific-purpose models and documents, for higher-level external documentation (e.g. requirements documents, use-case specifications, design notebooks, and reference manuals). All these artifacts require continual review and modification throughout the life-cycle to preserve their consistency and value. Good software documents are often heterogeneous, i.e., they combine different kinds of contents (text, code, models, images) gathered from separate software artifacts, a combination usually difficult to maintain as the system evolves over time, considering that source code, models and documents are typically produced and maintained separately in multiple sources using different environments and editors. This paper presents a wiki that helps on quickly weaving different kinds of contents into a single heterogeneous document, whilst preserving its semantic consistency. The fundamental goal of this wiki (XSDoc Wiki) is to reduce the development–documentation gap by making documentation more convenient and attractive to developers. An example taken from the JUnit framework documentation helps to illustrate the features more relevant to do such weaving. 1 0
WikiWiki weaving heterogeneous software artifacts Ademar Aguiar
Gabriel David
WikiSym 2005 - Conference Proceedings of the 2005 International Symposium on Wikis English 2005 Good documentation benefits every software development project, especially large ones, but it can be hard, costly, and tiresome to produce when not supported by appropriate tools and methods. The documentation of a software system uses different artifacts, namely source code, for low-level internal documentation, and specific-purpose models and documents, for higher-level external documentation (e.g. requirements documents, use-case specifications, design notebooks, and reference manuals). All these artifacts require continual review and modification throughout the life-cycle to preserve their consistency and value. Good software documents are often heterogeneous, i.e., they combine different kinds of contents (text, code, models, images) gathered from separate software artifacts, a combination usually difficult to maintain as the system evolves over time, considering that source code, models and documents are typically produced and maintained separately in multiple sources using different environments and editors. This paper presents a wiki that helps on quickly weaving different kinds of contents into a single heterogeneous document, whilst preserving its semantic consistency. The fundamental goal of this wiki (XSDoc Wiki) is to reduce the development-documentation gap by making documentation more convenient and attractive to developers. An example taken from the JUnit framework documentation helps to illustrate the features more relevant to do such weaving. Copyright 2005 ACM. 0 0