Re: What should a documentation contain, and what not

From: Valeri Fine (Faine) (fine@bnl.gov)
Date: Mon Oct 18 1999 - 22:29:18 MEST


> In this sense example code is an essential part of a documentation.
> On the other hand, considering the source code and thus the implementation
> an essential part of the user documentation violates quite a few of
> the principles of OO design.

  There is no need to argue the good documentation is a good
  thing. 

  However the laws of the mass production and the laws of the art
  are different somehow. The way one paints walls is not way the 
  artist does obey.

  Let me proposed we do not use an agrument like 

                   "violation of the OO law". 

  in the "technical" discussion. 
  I don't think those principles are as strict as the "speed of light"
  postulate.

  One may think there were no computer and software for 50 years 
  before OO "law" comes around.

  With my best regards.
                               Valery



This archive was generated by hypermail 2b29 : Tue Jan 04 2000 - 00:43:41 MET