[Elecraft] K3 Manual Updates
T. David Yarnes
w7aqk at cox.net
Sun Mar 9 19:31:31 EST 2008
I haven't followed all of this, so maybe it's already been
said. But having the document as a PDF file rules out (I
think) being able to neatly "edit" your copy. If it were in
something like Word, even as an alternative, it would be
easier for each person to update his or her file copy.
Alternatively, manual pages could be updated in much the
same fashion as various professional manuals are updated.
If a page need to be changed, then that page would be
changed accordingly. Then just the changed page would be
sent out as a page replacement in the manual. The manual
and the updates could be in PDF of course. If the change
caused the page to go longer than it did originally, you
would carry over that page to a second page, and give the
added page a page number the same as the page being changed,
but adding a letter or number to differentiate it from the
original and succeeding page. For example, if page 35 had
to be added to, to the point that more than one page were
necessary to fit in the changes, the overrun would go on
page 35A, or 35-1, or whatever similar system you want to
adopt for revisions.
I like to keep manuals in binders (3 ring type usually)
anyway. That way I can pull pages out for reference or
copying with ease. It also makes it a snap to update.
Now if you really want to follow through and do this first
rate, you would have a dated index for all updates. That
way, someone who is maybe a bit lax about updating can
always check to make sure they have inserted all the
updates. If not, they can do so and catch up.
I don't mind online manuals, but it would be nice to have
them issued in an organized format like this. Using the
method described above makes this easily possible. But if
you just issue errata info, then your manual can get pretty
messy with notes in the margin, etc.
There are lots of ways to do it, but this is one I know
works, and it isn't too difficult to manage.
Dave W7AQK
----- Original Message -----
From: "David Cutter" <d.cutter at ntlworld.com>
To: "Jerry Keller (K3BZ)" <k3bz at arrl.net>;
<elecraft at mailman.qth.net>
Sent: Sunday, March 09, 2008 7:15 AM
Subject: Re: [Elecraft] K3 Manual updates
> Jerry
>
> I agree. I'm getting decidedly twitchy (that's a
> technical word) about staying up to date. I know it's not
> beyond me, but I might just miss something crucial and
> then throw my teddy out of the pram when I do it wrong.
>
> If I print off the changes they can then be cut out and
> stuck on top of the offending passage in the printed
> manual, (you know: cut and paste) or a whole page replaced
> if required. You have to keep the revision numbers up to
> date.
>
> David
> G3UNA
>
More information about the Elecraft
mailing list