{"product_id":"agile-documentation-isbn-9780470856178","title":"Agile Documentation","description":"Software documentation forms the basis for all communication relating to a software project. To be truly effective and usable, it should be based on what needs to be known. \u003ci\u003eAgile Documentation\u003c\/i\u003e provides sound advice on how to produce lean and lightweight software documentation. It will be welcomed by all project team members who want to cut out the fat from this time consuming task. Guidance given in pattern form, easily digested and cross-referenced, provides solutions to common problems.  \u003cp\u003eStraightforward advice will help you to judge:\u003c\/p\u003e \u003cul\u003e \u003cli\u003eWhat details should be left in and what left out\u003c\/li\u003e \u003cli\u003eWhen communication face-to-face would be better than paper or online\u003c\/li\u003e \u003cli\u003eHow to adapt the documentation process to the requirements of individual projects and build in change\u003c\/li\u003e \u003cli\u003eHow to organise documents and make them easily accessible\u003c\/li\u003e \u003cli\u003eWhen to use diagrams rather than text\u003c\/li\u003e \u003cli\u003eHow to choose the right tools and techniques\u003c\/li\u003e \u003cli\u003eHow documentation impacts the customer\u003c\/li\u003e \u003c\/ul\u003e \u003cp\u003eBetter than offering pat answers or prescriptions, this book will help you to understand the elements and processes that can be found repeatedly in good project documentation and which can be shaped and designed to address your individual circumstance. The author uses real-world examples and utilises agile principles to provide an accessible, practical pattern-based guide which shows how to produce necessary and high quality documentation.\u003c\/p\u003e\"Agile Documentation\" ist ein knapper, äußerst lesenswerter und verständlich geschriebener Leitfaden zur der neuen Welt des Agile Software Development.\u003cbr\u003e \u003cbr\u003e Bislang wurde das Thema, wie man Software gut dokumentiert, in der Literatur eher stiefmütterlich behandelt.\u003cbr\u003e \u003cbr\u003e Der Band basiert auf einer Vielzahl von Beispielen aus der Praxis.\u003cbr\u003e \u003cbr\u003e \"Agile Documentation\" - ein praktischer Leitfaden für die Erstellung prägnanter und \"leichtgewichtiger\" Dokumentationen für Softwareprojekte. \u003cp\u003eForeword ix\u003c\/p\u003e \u003cp\u003ePreface xi\u003c\/p\u003e \u003cp\u003eAcknowledgements xvii\u003c\/p\u003e \u003cp\u003eIntroduction 1\u003c\/p\u003e \u003cp\u003eProject Background 11\u003c\/p\u003e \u003cp\u003e\u003cb\u003e1 Finding the Right Topics 19\u003c\/b\u003e\u003c\/p\u003e \u003cp\u003eTarget Readers 24\u003c\/p\u003e \u003cp\u003eFocused Information 26\u003c\/p\u003e \u003cp\u003eIndividual Documentation Requirements 28\u003c\/p\u003e \u003cp\u003eDocumentation Portfolio 30\u003c\/p\u003e \u003cp\u003eFocus on Long-Term Relevance 34\u003c\/p\u003e \u003cp\u003eSpecification as a Joint Effort 36\u003c\/p\u003e \u003cp\u003eDesign Rationale 39\u003c\/p\u003e \u003cp\u003eThe Big Picture 40\u003c\/p\u003e \u003cp\u003eSeparation of Description and Evaluation 42\u003c\/p\u003e \u003cp\u003eRealistic Examples 44\u003c\/p\u003e \u003cp\u003eExperience Reports 46\u003c\/p\u003e \u003cp\u003e\u003cb\u003e2 Structuring Individual Documents 61\u003c\/b\u003e\u003c\/p\u003e \u003cp\u003eStructured information 66\u003c\/p\u003e \u003cp\u003eJudicious Diagrams 70\u003c\/p\u003e \u003cp\u003eUnambiguous Tables 73\u003c\/p\u003e \u003cp\u003eGuidelines for Readers 75\u003c\/p\u003e \u003cp\u003eThumbnail Sketches 77\u003c\/p\u003e \u003cp\u003eTraceable References 78\u003c\/p\u003e \u003cp\u003eGlossary 79\u003c\/p\u003e \u003cp\u003eDocument History 81\u003c\/p\u003e \u003cp\u003eExperience Reports 82\u003c\/p\u003e \u003cp\u003e\u003cb\u003e3 Layout and Typography\u003c\/b\u003e\u003cb\u003e 93\u003c\/b\u003e\u003c\/p\u003e \u003cp\u003eText on 50% of a Page 98\u003c\/p\u003e \u003cp\u003eTwo Alphabets per Line 100\u003c\/p\u003e \u003cp\u003e120% Line Spacing 102\u003c\/p\u003e \u003cp\u003eTwo Typefaces 104\u003c\/p\u003e \u003cp\u003eCareful Use of Type Variations 106\u003c\/p\u003e \u003cp\u003eCareful Ruling and Shading 108\u003c\/p\u003e \u003cp\u003eAdjacent Placement 109\u003c\/p\u003e \u003cp\u003eCoherent Pages 111\u003c\/p\u003e \u003cp\u003eExperience Reports 112\u003c\/p\u003e \u003cp\u003e\u003cb\u003e4 Infrastructure and Technical Organisation\u003c\/b\u003e \u003cb\u003e117\u003c\/b\u003e\u003c\/p\u003e \u003cp\u003eDocument Landscape 120\u003c\/p\u003e \u003cp\u003eDocument Archive 123\u003c\/p\u003e \u003cp\u003eWiki 125\u003c\/p\u003e \u003cp\u003eCode-Comment Proximity 126\u003c\/p\u003e \u003cp\u003eReader-Friendly Media 128\u003c\/p\u003e \u003cp\u003eSeparation of Contents and Layout 131\u003c\/p\u003e \u003cp\u003eSingle Source and Multiple Targets 133\u003c\/p\u003e \u003cp\u003eImport by Reference 136\u003c\/p\u003e \u003cp\u003eSeparation of Processing and Printing 138\u003c\/p\u003e \u003cp\u003eDocument Templates 139\u003c\/p\u003e \u003cp\u003eFew Tools 142\u003c\/p\u003e \u003cp\u003eAnnotated Changes 144\u003c\/p\u003e \u003cp\u003eNotification upon Update 145\u003c\/p\u003e \u003cp\u003eReorganisation upon Request 147\u003c\/p\u003e \u003cp\u003eExperience Reports 149\u003c\/p\u003e \u003cp\u003e\u003cb\u003e5 Management \u003c\/b\u003e\u003cb\u003eand \u003c\/b\u003e\u003cb\u003eQuality \u003c\/b\u003e\u003cb\u003eAssurance 159\u003c\/b\u003e\u003c\/p\u003e \u003cp\u003eA Distinct Activity 161\u003c\/p\u003e \u003cp\u003eOne Responsible Author 164\u003c\/p\u003e \u003cp\u003eContinuing Documentation 166\u003c\/p\u003e \u003cp\u003eWriting and Reflection 168\u003c\/p\u003e \u003cp\u003eReview Culture 170\u003c\/p\u003e \u003cp\u003eReview Before Delivery 174\u003c\/p\u003e \u003cp\u003eCustomer Review 175\u003c\/p\u003e \u003cp\u003eA Distant View 177\u003c\/p\u003e \u003cp\u003eInformation Marketplace 179\u003c\/p\u003e \u003cp\u003eKnowledge Management 180\u003c\/p\u003e \u003cp\u003eExperience Reports 182\u003c\/p\u003e \u003cp\u003e\u003cb\u003eFinal Remarks 193\u003c\/b\u003e\u003c\/p\u003e \u003cp\u003e\u003cb\u003ePattern Thumbnails 197\u003c\/b\u003e\u003c\/p\u003e \u003cp\u003eFinding the Right Topics 197\u003c\/p\u003e \u003cp\u003eStructuring Individual Documents 198\u003c\/p\u003e \u003cp\u003eLayout and Typography 200\u003c\/p\u003e \u003cp\u003eInfrastructure and Technical Organisation 201\u003c\/p\u003e \u003cp\u003eManagement and Quality Assurance 203\u003c\/p\u003e \u003cp\u003eGlossary 205\u003c\/p\u003e \u003cp\u003eReferences 211\u003c\/p\u003e \u003cp\u003eIndex 221\u003c\/p\u003e  ??many (Test Documents) would benefit from this treatment?? (Professional Tester, October 03)  \u003cp\u003e\"...applicable to documentation for any project...highly recommended...\" (CVu, Vol 16(4), August 2004)\u003c\/p\u003e \u003cb\u003eAndreas Rüping\u003c\/b\u003e is a member of the patterns think-tank, Hillside Europe, and has acted as the chairman of several EuroPLoP Conferences. He has 12 years industry experience of software development, most recently as a software engineer and consultant at sd\u0026amp;m software design \u0026amp; management AG in Germany.  \u003ci\u003e\u003cb\u003eDocumentation is the castor oil of programming. Managers think it is good for programmers, and programmers hate it!\u003c\/b\u003e\u003c\/i\u003e Jerry Weinberg in Psychology of Computer Programming  \u003cp\u003eAndreas Rüping sugars the pill by giving sound advice on how to produce lean and lightweight software documentation. It will be welcomed by all project team members who want to cut out the fat from this time consuming task. Guidance given in pattern form, easily digested and cross-referenced, provides solutions to common problems. Straightforward advice will help you to judge:\u003c\/p\u003e \u003cul\u003e \u003cli\u003eWhat details should be left in and what left out\u003c\/li\u003e \u003cli\u003eWhen communication face-to-face would be better than paper or online\u003c\/li\u003e \u003cli\u003eHow to adapt the documentation process to the requirements of individual projects and build in change\u003c\/li\u003e \u003cli\u003eHow to organise documents and make them easily accessible\u003c\/li\u003e \u003cli\u003eWhen to use diagrams rather than text\u003c\/li\u003e \u003cli\u003eHow to choose the right tools and techniques\u003c\/li\u003e \u003cli\u003eHow documentation impacts the customer\u003c\/li\u003e \u003c\/ul\u003e \u003cp\u003eBetter than offering pat answers or prescriptions, this book will help you to understand the elements and processes that can be found repeatedly in good project documentation and which can be shaped and designed to address your individual circumstance. The author uses real-world examples and utilises agile principles to provide an accessible, practical pattern-based guide which shows how to produce necessary and high quality documentation.\u003c\/p\u003e","brand":"Wiley","offers":[{"title":"Default Title","offer_id":47988706967781,"sku":"NP9780470856178","price":50.0,"currency_code":"USD","in_stock":false}],"thumbnail_url":"\/\/cdn.shopify.com\/s\/files\/1\/1842\/7735\/files\/9780470856178.jpg?v=1761781269","url":"https:\/\/k12savings.com\/products\/agile-documentation-isbn-9780470856178","provider":"K12savings","version":"1.0","type":"link"}