Patterns for consistent software documentation

Filipe Figueiredo Correia, Ademar Aguiar, Hugo Sereno Ferreira, Nuno Flores
<span title="">2010</span> <i title="ACM Press"> Proceedings of the 16th Conference on Pattern Languages of Programs - PLoP &#39;09 </i> &nbsp;
Documentation is an important part of the captured knowledge of a software project, providing a flexible and effective way of recording informal contents. However, maintaining documentation's consistency requires a considerable effort. Existing solutions encompass different tools and approaches that support the process of creating, evolving and using documents and other artifacts derived from the software development process. Based on existing literature and expertise, we have identified the
more &raquo; ... problems and solutions for documentation consistency. In concrete, four distinct patterns and their relations were identified, which are here described -Information Proximity, Co-Evolution, Domain-Structured Information and Integrated Environment.
<span class="external-identifiers"> <a target="_blank" rel="external noopener noreferrer" href="https://doi.org/10.1145/1943226.1943241">doi:10.1145/1943226.1943241</a> <a target="_blank" rel="external noopener" href="https://fatcat.wiki/release/jy7oggraczer3fere3zajuatay">fatcat:jy7oggraczer3fere3zajuatay</a> </span>
<a target="_blank" rel="noopener" href="https://web.archive.org/web/20101223224510/http://www.hillside.net/plop/2009/papers/ACMVersions/correia.pdf" title="fulltext PDF download" data-goatcounter-click="serp-fulltext" data-goatcounter-title="serp-fulltext"> <button class="ui simple right pointing dropdown compact black labeled icon button serp-button"> <i class="icon ia-icon"></i> Web Archive [PDF] <div class="menu fulltext-thumbnail"> <img src="https://blobs.fatcat.wiki/thumbnail/pdf/d2/7c/d27cb64d239ee12ab508d219bf58e304b07c5a7a.180px.jpg" alt="fulltext thumbnail" loading="lazy"> </div> </button> </a> <a target="_blank" rel="external noopener noreferrer" href="https://doi.org/10.1145/1943226.1943241"> <button class="ui left aligned compact blue labeled icon button serp-button"> <i class="external alternate icon"></i> acm.org </button> </a>