Comment Re:I hope you are the only one. (Score 1) 528
You miss my point. The point is that an appropriate level of documentation is always correct, but at some level, the system should explain itself to some degree. No programmer worth their salt goes through and writes comments like, "This is a function. The function "get_an_integer" gets an integer." That's inane, because any programmer taking over should be able to look at the system and figure it out, because there are industry/practice-standard ways of writing and doing things that are meant to make such knowledge transferable.
Hence with documenting the network -- some of it should simply explain itself. Yes, if there's specific, custom ways it is configured, it should be documented, but those custom configs should be few and far between to keep the need for documentation low. I only say all this because the way the OP phrased his question made it sound like the entire contraption was this Rube Goldberg machine of networking components that would require some complex PhD to understand, and that sounds like a problem with implementation, not with documentation.
Hence with documenting the network -- some of it should simply explain itself. Yes, if there's specific, custom ways it is configured, it should be documented, but those custom configs should be few and far between to keep the need for documentation low. I only say all this because the way the OP phrased his question made it sound like the entire contraption was this Rube Goldberg machine of networking components that would require some complex PhD to understand, and that sounds like a problem with implementation, not with documentation.