Re: 3D: Documentation Driven Development

whit <[email protected]> Fri, 14 Jul 2006 10:39:54 -0400
Newsgroups gmane.comp.web.zope.plone.archetypes.devel
Message-ID <[email protected]>
> I quite like the idea of proposals being executable tests, in fact. I 
> wonder whether perhaps we could manage some of the meta-data and 
> high-level overview in the PSC still; just more general points about the 
> rationale, the problem and so on, so that we had a bit more visibility 
> of what's going on and what state it's in. The list is great for things 
> being dicussed right now, but less good for piecing together the state 
> of discussion and progress (which may be hard to glean from hard code or 
> even tests, too, unless you're careful) a few months down the line.
> 
> Note the a PSC proposal can link to an svn branch where development 
> happens, so if the text there is fairly short (and at a high enough 
> level for regular people to figure out what's going on, in general) it 
> can defer to the text for all specifics.

maybe the simplest possible thing for infrastructure stuff is having 
some sort of direct link from  the doctest in the project description, 
or a convention of where to put the proposal/doctest.

> Put it differently: I find the text of your doctest at the moment a bit 
> confusing for getting the bigger picture, and I'm sure I'm not the only 
> one. Also, with *just* a doctest in svn, we'd have to manage the process 
> of what proposals are intended for what releases and what state they're 
> in by memory and emails back and forth. 

and that's a trac or PSC problem, something a bit further down the line.

These are the problems the
> PSC/PLIP infrastructure solve for Plone and tons of other products. I 
> think they're orthogonal to describing low-level changes in terms of a 
> doctest, though (which I think it's a bloody great idea).
> 

right...this in no way is a substitute to roadmaps and other higher 
level project management. my main observation was that I usually follow 
a pattern with this list: I describe what I think ought to be done, 
people ask for clarification, I write some pseudo code to explain that 
could very well be the api for a simple implementation.


-w

-------------------------------------------------------------------
> Using Tomcat but need to do more? Need to support web services, security?
> Get stuff done quickly with pre-integrated technology to make your job easier
> Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
> http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642


-- 

  | david "whit" morriss
  |
  | contact :: http://public.xdi.org/=whit

  "If you don't know where you are,
   you don't know anything at all"

   Dr. Edgar Spencer, Ph.D., 1995


  "I like to write code like
  other ppl like to tune their
  cars or 10kW hifi equipment..."

  Christian Heimes, 2004



-------------------------------------------------------------------------
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642