Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Content Layer
background-repeatno-repeat
background-sizecover
id629396393
background-positiontop center
colortransparent
id191841124
classsmartics-large
Content Column
tabbed-blocksfalse
width100.0%
id191841134
Content Block
background-colortransparent
nameWilliam Zinsser
id191841144
Quote External
authorWilliam Zinsser
sourceOn Writing Well
author-urihttp://www.williamzinsserwriter.com/

Writing is hard work. A clear sentence is no accident. Very few sentences come out right the first time, or even the third time. Remember this as a consolation in moments of despair. If you find that writing is hard, it's because it is hard. It's one of the hardest things that people do.

Content Block
nameScott Ambler
id191841141
Quote External
source-urihttp://www.agilemodeling.com/essays/agileDocumentationBestPractices.htm
authorScott Ambler
sourceBest Practices for Agile/Lean Documentation
author-urihttp://www.ambysoft.com/scottAmbler.html

Comprehensive documentation does not ensure project success, in fact, it increases your chance of failure.

Content Block
nameMike Clark
id192590444
Quote External
source-urihttp://pragprog.com/book/auto/pragmatic-project-automation
authorMike Clark
sourcePragmatic Project Automation: How to Build, Deploy, and Monitor Java Applications

Automation also reduces the need for documentation.

Content Block
nameRebecca Wirfs
id192573411
Quote
source-wiki-pageWirfs-Brock2003

Design is an inherently messy process, and along the way many descriptions are discarded after serving their purpose.

Content Block
nameRon Jeffries
id1056388317
Quote External
source-urihttp://xprogramming.com/xpmag/expDocumentationInXP
authorRon Jeffries
sourceEssential XP: Documentation
author-urihttp://en.wikipedia.org/wiki/Ron_Jeffries

Outside your extreme programming project, you will probably need documentation: by all means, write it. Inside your project, there is so much verbal communication that you may need very little else. Trust yourselves to know the difference.

Content Block
nameJoe Ottinger
id193252920
Quote External
source-urihttp://www.theserverside.com/tip/Hand-pick-the-right-Java-library-for-your-software-project
authorJoe Ottinger
sourceHand pick the right software project for your situation

It’s probably fair to say that poor documentation kills more libraries and tools than any other issue.

Content Block
nameEric Evans
id193266477
Quote External
authorEric Evans
sourceDomain-Driven Design
author-urihttp://www.amazon.com/Eric-Evans/e/B001KDCO2I

But making written documents that actually help the team produce good software is a challenge.

Content Column
width100%
id629396395
1
Content Block
id