|
Boost : |
Subject: Re: [boost] Improving Boost Docs
From: Robert Ramey (ramey_at_[hidden])
Date: 2017-08-14 14:37:44
On 8/14/17 12:40 AM, Andrzej Krzemienski via Boost wrote:
> I do not know anything about the project, so I am not really addressing
> your question,but I wonder how it is possible to get a unified look and
> feel across all the libraries when library authors are given freedom to use
> whatever format for their documentation, whatever tool, and whatever
> approach to documentation.
I don't think it is possible.
This leaves us with a couple of options:
a) Enforce the usage of boost book for documentation as condition of
acceptance and inclusion of a library in boost. This would guarantee
consistent look and feel across libraries.
b) Encourage everyone to "do their own thing". Which would almost
certainly result in a wide variation of look and field.
c) Improve the boostbook documentation and related tooling to make it so
compelling that only an idiot or egomaniac would decide not to use it.
This would be the best of course. But it's a lot of work and we're not
there yet. And of course in any large organization, there's always a
couple of idiots/ecomaniacs or people who act that way on an occasional
basis.
Actually, this was the motivation for my post. I think when this
initiative was announced we were on the right track. But I think we
lost our way on this one. I don't know if it's possible to all get back
on the same page, but it would be a good thing if we could.
Robert Ramey
Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk