[bind10-dev] asio jpg images

[JINMEI Tatuya / 神明達哉]

At Mon, 21 May 2012 22:24:04 +0200,
Shane Kerr <shane at isc.org> wrote:

> > >> I couldn't find any file that referenced them. If we should keep
> > >> in the source tree maybe some document should reference them.
> > > 
> > > It would be helpful to have a design document like this somewhere
> > > more visible (e.g., on a wiki page).
> > Wiki pages tend to get outdated. IMHO the best way for such
> > developer-oriented documents is to keep them as close to the code as
> > possible.
> 
> I think Jinmei's suggestion was rather that we should publish the
> documents where someone can see it without downloading a tarball. :)

Actually I didn't think about that level of details:-) I just thought
it would be nice if such diagrams are more visible with some other
design document, whether it's part of source code or in wiki or
somewhere else.

Regarding in-source documentation, I generally agree that it's easier
to keep them more up-to-date.  But, of course, simply because
documenting in the source tree doesn't mean it's more maintained.
These jpg images are a good example I think (as I said, I've not even
been aware of their existence:-)

---
JINMEI, Tatuya