Re: Google Season of Docs

From: pbristow_at_[hidden]
Date: 2020-04-23 08:31:09

> -----Original Message-----
> From: Boost <boost-bounces_at_[hidden]> On Behalf Of Damian Vicino via
> Boost
> Sent: 23 April 2020 03:24
> To: boost_at_[hidden]
> Cc: Damian Vicino <damian_at_[hidden]>
> Subject: Re: [boost] Google Season of Docs
> 
> I think working in moving documentation from one tech used for writing it to
> another (ie. docbook to asciidoc) its not well tailored for a GSOD project.
> A good highschool student with enough motivation to do a lot of copy paste and
> formatting can do that during a google code-in project (or many).
> Also, after years of following this list I'm pretty sure we will not get half
the
> maintainers to agree in a single tech to document anything.

Definitely.  No chance.

Almost every library has 'done their own thing' in various way, either by using
a different tool, or by using an existing tool differently.

> If we get a professional documenter, which is what GSOD provides, it should be
for
> something where a good writer is required skill. ie. tutorials, new docs,
completing
> docs with missed pieces of it. Analysing and fixing consistency in the writing
across
> all libraries, etc...

The difference in type and scale means that 'one-size-fits-all' is unlikely to
apply.

Some are simple, others have many, many functions, some have tons of templates,
others are mostly meta-magic...

Have you looked at the difference in size between Boost.Math (near 20 MB) and
Boost.Array (near 100 KB), for example?

Paul