Re: Writing Boost Documentation

From: bill_kempf (williamkempf_at_[hidden])
Date: 2002-02-04 11:44:22

--- In boost_at_y..., "dave_abrahams" <david.abrahams_at_r...> wrote:
> --- In boost_at_y..., "David Abrahams" <david.abrahams_at_r...> wrote:
> > 
> > ----- Original Message -----
> > From: "bill_kempf" <williamkempf_at_h...>
> > 
> > 
> > > I'm not sure I know what you mean by this last sentence.  If 
you 
> said
> > > it the other way around it would make more sense to me :).  The
> > > templates are an attempt to codify *everything* stated in both 
the
> > > structure documentation as well as the design documentation.
> > 
> > They can codify structure, but are much more limited in their 
> ability to
> > shape content. The "structure doc" seemed to say lots about how 
the 
> content
> > should look. That was my impression, anyway.
> 
> Y'know what? I typed too soon. This material is terrific. I just 
> looked at it again, and I don't think there's anything particularly 
> daunting about it. I would still like to see more discussion of 
> tutorial and example materials, but it's a great start.

I agree about the tutorial and example materials.  I did say this was 
a first rough draft ;).  I was hoping the draft would generate 
comments and even motivate others to make corrections/add material.

I'm glad you think it's useful, though.  Is it useful enough to add 
to the Boost web site?  If so, what needs to be done to get it to a 
point that we can add it (taking in mind that we can always add to it 
in the future as well)?

Bill Kempf