RE: [AM] Plato on Documentation

David Robrecht <[email protected]> Mon, 15 Mar 2004 12:11:50 +0100
Newsgroups gmane.comp.programming.modeling.agile
Message-ID <[email protected]>
I agree. I never expect my documents to be clear. But I do write them and sometimes expect documentation from others.
 
To often a manual is "used" to escape explaining the content of it interactively.
People think it will save them time when they write down what they know and then expect the document to be self explaining.
The result of this is that a lot of people do not understand the document and cannot get a good introduction or explanation because they "should" read and understand the manual.
 
This observation too often leads to disappointment and the conclusion that documention serves no purpose.
The result of this beeing a lot of time spent on a multitude of private documentation to preserve the memory of the explanation received.
 
Documentation to me is what I give to others so that they do not need to take notes when I am talking to them. Documentation is also something to write your own notes on. It does not exclude the need for real interaction about the subject.
 
Robrecht
 

	-----Oorspronkelijk bericht----- 
	Van: Scott Ambler [mailto:[email protected]] 
	Verzonden: vr 12/03/2004 17:35 
	Aan: [email protected] 
	CC: 
	Onderwerp: [AM] Plato on Documentation
	
	

	Plato once said “…anyone who leaves behind him a written manual, and
	likewise anyone who receives it, in the belief that such writing will be
	clear and certain, must be exceedingly simple-minded…”.   Thoughts?
	
	- Scott
	
	====================================================
	Scott W. Ambler
	Senior Consultant, Ronin International, Inc.
	www.ronin-intl.com/company/scottAmbler.html
	
	www.agiledata.org
	www.agilemodeling.com
	www.ambysoft.com
	www.enterpriseunifiedprocess.info
	www.modelingstyle.info
	www.ronin-intl.com
	
	For more information about AM, visit the Agile Modeling Home Page at www.agilemodeling.com
	
	
	
	


For more information about AM, visit the Agile Modeling Home Page at www.agilemodeling.com
--^----------------------------------------------------------------
This email was sent to: [email protected]

EASY UNSUBSCRIBE click here: http://topica.com/u/?bUrKDA.bWnbtk.Z2NtYS1h
Or send an email to: [email protected]

For Topica's complete suite of email marketing solutions visit:
http://www.topica.com/?p=TEXFOOTER
--^----------------------------------------------------------------
winmail.dat (application/ms-tnef, 5.3 KB) - not displayed