Agile Documentation : A Pattern Guide to Producing Lightweight Documents for Software Projects

Andreas Rüping

  • 出版商: Wiley
  • 出版日期: 2003-09-11
  • 售價: $1,790
  • 貴賓價: 9.5$1,701
  • 語言: 英文
  • 頁數: 246
  • 裝訂: Paperback
  • ISBN: 0470856173
  • ISBN-13: 9780470856178
  • 相關分類: Agile Software
  • 海外代購書籍(需單獨結帳)



Andreas 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:

  • What details should be left in and what left out
  • When communication face-to-face would be better than paper or online
  • How to adapt the documentation process to the requirements of individual projects and build in change
  • How to organise documents and make them easily accessible
  • When to use diagrams rather than text
  • How to choose the right tools and techniques
  • How documentation impacts the customer

Better 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.

Table of Contents





Project Background.

1. Finding the Right Topics.

2. Structuring Individual Documents.

3. Layout and Typography.

4. Infrastructure and Technical Organisation.

5. Management and Quality Assurance.

Final Remarks.

Pattern Thumbnails.





Andreas Rüping在如何製作精簡輕量級軟體文件的過程中提供了實用的建議,讓這項耗時的任務更加容易執行。這本書將受到所有專案團隊成員的歡迎,他們希望從這項任務中減少冗餘內容。書中以模式形式提供指導,易於理解和交叉參考,解決了常見問題。直接的建議將幫助您判斷:
- 哪些細節應該保留,哪些應該省略
- 何時面對面溝通比紙質或線上溝通更好
- 如何根據個別專案的需求調整文件製作流程並引入變更
- 如何組織文件並使其易於存取
- 何時使用圖表而不是文字
- 如何選擇合適的工具和技術
- 文件對客戶的影響


- 前言
- 序言
- 致謝
- 簡介
- 專案背景
- 1. 尋找合適的主題
- 2. 結構化個別文件
- 3. 版面設計和排版
- 4. 基礎設施和技術組織
- 5. 管理和品質保證
- 結語
- 模式縮略圖
- 詞彙表
- 參考資料
- 索引