The Computer Journal
A hypertext system for literate C++ programming
Journal of Object-Oriented Programming
API documentation from source code comments: a case study of Javadoc
SIGDOC '99 Proceedings of the 17th annual international conference on Computer documentation
Dynamic hypertext: querying and linking
ACM Computing Surveys (CSUR)
Hypermedia on the Web: what will it take?
ACM Computing Surveys (CSUR)
JavaML: a markup language for Java source code
Proceedings of the 9th international World Wide Web conference on Computer networks : the international journal of computer and telecommunications netowrking
Documenting software systems with views II: an integrated approach based on XML
SIGDOC '01 Proceedings of the 19th annual international conference on Computer documentation
Elucidative programming in Java
IPCC/SIGDOC '00 Proceedings of IEEE professional communication society international professional communication conference and Proceedings of the 18th annual ACM international conference on Computer documentation: technology & teamwork
Towards large-scale information integration
Proceedings of the 24th International Conference on Software Engineering
Supporting document and data views of source code
Proceedings of the 2002 ACM symposium on Document engineering
Towards Portable Source Code Representations Using XML
WCRE '00 Proceedings of the Seventh Working Conference on Reverse Engineering (WCRE'00)
Wikis of locality: insights from the open guides
Proceedings of the 2006 international symposium on Wikis
On-line collaborative software development via wiki
Proceedings of the 2007 international symposium on Wikis
Generating design knowledge though data mining
Journal of Computing Sciences in Colleges
Proceedings of the 27th ACM international conference on Design of communication
Sharing architecture knowledge through models: Quality and cost
The Knowledge Engineering Review
Adessowiki on-line collaborative scientific programming platform
Proceedings of the 5th International Symposium on Wikis and Open Collaboration
Incremental knowledge acquisition in software development using a weakly-typed Wiki
Proceedings of the 5th International Symposium on Wikis and Open Collaboration
Supporting the evolution of software knowledge with adaptive software artifacts
Proceedings of the ACM international conference companion on Object oriented programming systems languages and applications companion
Patterns for consistent software documentation
Proceedings of the 16th Conference on Pattern Languages of Programs
Wikigramming: a wiki-based training environment for programming
Proceedings of the 2nd International Workshop on Web 2.0 for Software Engineering
Design guidelines for software processes knowledge repository development
Information and Software Technology
Proceedings of the 29th ACM international conference on Design of communication
Hi-index | 0.00 |
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.