[Info-vax] VMS documentation, was: Re: callable BACKUP example
Simon Clubley
clubley at remove_me.eisner.decus.org-Earth.UFP
Fri Jul 30 13:50:32 EDT 2021
On 2021-07-29, Zane H. Healy <healyzh at avanthar.avanthar.com> wrote:
>
> This touches on one of my pet-peaves. IT Management seems to think that
> anyone can write documentation. For years I told them that we really needed
> to hire an expert that is shared among all the teams. I finally gave up on
> trying to convince them. No one wants to spend the money for a technical
> writer, especially when everyone is so short-handed.
>
> Then there was that one Senior Manager that told us that we didn't need
> documentation, we should simply read the code...
>
No argument here. :-)
The code tells you _what_ it is doing.
It doesn't tell you _why_ it is doing that.
The documentation also tells you how all the pieces fit together.
Simon.
--
Simon Clubley, clubley at remove_me.eisner.decus.org-Earth.UFP
Walking destinations on a map are further away than they appear.
More information about the Info-vax
mailing list