Quinn DuPont studies the critical history of software technologies, focusing on metaphysical, historical, and political issues. Recently, he studied the history of email, and modes of production for software development. Currently, he studies historical and philosophical issues of encryption, and software preservation. Quinn is currently a MITACS Enhanced Accelerate PhD Fellow and Faculty of Information PhD student at the University of Toronto.

search
reading
  • Vibrant Matter: A Political Ecology of Things
    Vibrant Matter: A Political Ecology of Things
    by Jane Bennett
  • The Order of Things: An Archaeology of Human Sciences
    The Order of Things: An Archaeology of Human Sciences
    by Michel Foucault
  • Semiotics and the Philosophy of Language
    Semiotics and the Philosophy of Language
    by Umberto Eco
« Chp. 7: Ongoing review of Building Enterprise Taxonomies by Darin L. Stewart | Main | Taxonomies, structure, and information theory »
Thursday
Sep112008

Agile Development and Documentation

It was once the case that technical documentation came in bound books. Yes, those large books that no one ever reads.The podcast I'd Rather Be Writing takes a look at the traditional wisdom of documentation and compares that with documentation in an Agile development context. It is argued that

some agile environments move so fast, you have to triage what you document because there’s no time to document everything.
The point is that not only is there not enough time to document everything, you shouldn't document everything because "you end up giving everything equal importance and losing focus on the key tasks and concepts users need to learn". The recommendation by I'd Rather Be Writing is that everything should be documented somewhere, but the user should be presented with quick references and tutorials that focus their attention to the most important aspects.

This is a fine approach, but rather outdated. Minimalism and Information Mapping have been furthered by technological advances. It is now possible to write in a strictly topic-based style that offers little narrative verbiage (or context), but gets the user directly to the relevant information. Discrete topics can direct the user to the necessary information through sophisticated information retrieval technologies: semantically-rich search, and ontologies for browsing.



References (1)

References allow you to track sources for this article, as well as articles that were written in response to this article.