categoryallspace2-Agile Documentation http://tc.eserver.org/dir/Agile/Documentation A directory of resources about agile and documentation in the field of technical communication. en-us Copyright (c) 2005-08 by the EServer. All rights reserved. tclib-editorial@eserver.org (TC Library Editorial Board) webmaster@eserver.org (Geoffrey Sauer) http://tc.eserver.org/images/newlogo.gif http://tc.eserver.org/dir/Agile/Documentation http://tc.eserver.org/31163.html http://tc.eserver.org/31163.html Documentation teams need a fast and effective review process to move forward on their projects and deliver quality, timely content. Reviewers, may they be SMEs (Subject Matter Experts) or key organization authorities, are usually extremely busy and have limited time (or interest) to review documentation. Interesting dilemma, no? http://tc.eserver.org/30762.html http://tc.eserver.org/30762.html Storytelling can make documentation more exciting for both writers and readers. Stories provide context and people tend to remember them. More all-∆around fun when stories are tests. http://tc.eserver.org/30729.html http://tc.eserver.org/30729.html Documentation is an important part of agile software development projects, but unlike traditionalists who often see documentation as a risk reduction strategy, agilists typically see documentation as a strategy which increases overall project risk and therefore strive to be as efficient as possible when it comes to documentation. Agilists write documentation when that's the best way to achieve the relevant goals, but there often proves to be better ways to achieve those goals than writing static documentation. This article summarizes common "best practices" which agilists have adopted with respect to documentation. http://tc.eserver.org/28121.html http://tc.eserver.org/28121.html A Test Map is a list of unit tests associated with a specific function/method under test. It helps you see how that specific function/method is being exercised via unit tests. http://tc.eserver.org/27609.html http://tc.eserver.org/27609.html When it comes to getting work done, replace written documentation with more efficient forms of communication. To guide future work, create documents at the end of the project, when everything is complete, well understood, and easy to document. http://tc.eserver.org/27601.html http://tc.eserver.org/27601.html Why do we bother with models or documentation? They don't execute, and our customers pay us for working code, not pretty pictures. We bother with models to communicate. The idea is that a graphical object model can show how objects fit together more clearly than looking at the source, an interaction diagram can show a collaboration better than figuring out the call path from several class definitions. But so often the design documentation fails in this, and leaves me puzzled on my sofa. http://tc.eserver.org/27603.html http://tc.eserver.org/27603.html Discusses the life cycle of Story Cards, what they should be, how to use them and what to watch out for. http://tc.eserver.org/27604.html http://tc.eserver.org/27604.html The basic idea is that very little of the documentation which gets created during software development actually gets read by the actual target audience. This article explains the problem and presents advice for addressing it. http://tc.eserver.org/27589.html http://tc.eserver.org/27589.html In Agile Documentation, Rüping gets to the heart of the documentation dilemma, offering a two-word solution: minimum necessary. http://tc.eserver.org/27590.html http://tc.eserver.org/27590.html With limited staff, a rapidly changing IT environment, and increasing complexity, my own inflexible documentation practices had to be updated to reflect more dynamic environments. http://tc.eserver.org/27591.html http://tc.eserver.org/27591.html Recently, Agile Software Processes have been discussed as flexible and light-weight alternatives to established Software Engineering approaches, in order to overcome the obstacles created by the cost of producing and maintaining documents on higher abstraction levels. Depending on requirements and needs on the documents itself, Agile Documentation becomes a key issue and brings up questions on how to create, maintain and distribute documents among the team members without creating unnecessary or unjustifiable cost. This paper describes a technique allowing to produce documentation automatically, by conducting analysis on the series of development steps taken during project planning and enactment. http://tc.eserver.org/27588.html http://tc.eserver.org/27588.html When I initially started work on Agile Modeling (AM) I wanted to focus solely on principles and practices for effective modeling but quickly discovered that this scope was not sufficient, that I also needed to consider the issue of how to be effective at the creation and maintenance of documentation too. Some agile models will �evolve� into official system documentation, although the vast majority will not, and therefore it is relevant to discuss how to be agile doing so. http://tc.eserver.org/27572.html http://tc.eserver.org/27572.html What quicker way can there be to find out if something is teachable than to write up task-oriented documentation? And as things are built or changed, the documentation is updated. I often update the documentation before the code! http://tc.eserver.org/27586.html http://tc.eserver.org/27586.html Extreme Programming (or XP) is a popular software development process that encourages a return to the days of little or no documentation, Design After First Testing, and Constant Refactoring After Programming. Despite its popularity, not everyone thinks XP is a good idea. http://tc.eserver.org/27587.html http://tc.eserver.org/27587.html This is a description of a simple software-internals documentation format and process. It is derived from the Unified Software Development Process, simplified towards eXtreme Programming compatibility, and arranged for realisation in a plain text file. http://tc.eserver.org/27585.html http://tc.eserver.org/27585.html A broader awareness of how changes can impact other things, including schedule commitments and work outside of the immediate area of change, is beneficial in terms of assessing trade-offs and benefits. http://tc.eserver.org/19666.html http://tc.eserver.org/19666.html A revolution is under way in software development, revolving around agile methodologies that allow more room for design changes based on input from customers during development. One popular agile methodology is eXtreme Programming (XP).