TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Help in Planning From:Bruce Byfield <bbyfield -at- axionet -dot- com> To:techwr-l digest recipients <techwr-l -at- lists -dot- raycomm -dot- com>, sona -dot- mehta -at- haysmt -dot- co -dot- uk Date:Wed, 14 Jun 2000 08:16:50 -0700
Sona Mehta <sona -dot- mehta -at- haysmt -dot- co -dot- uk> wrote:
>How do I tell what are the last level tasks that I will be doing even
>before I understand what needs to be changed in the document? I know the
>higer level tasks like
>1. Understanding the code (Very difficult, any suggestions on how to go
From your post, I assume that you don't read C code. While that
would be a useful skill to learn, for now:
1.) Opening the code in a text editor and reading comments. With
luck, the coder who left will have left enough information for
you to know what to expect. If not, then urge that your company
use more comments. Warning: read a copy of the source code, or
else open in read-only mode.
2.) Sit down with a coder. You could just pick his/her brains,
but it would more useful in the long run to ask for a basic guide
to reading code. For your purposes, you may not need to read code
fluently. You might be able to get by with a few basics to point
you to the parts of the code you need to read.
3.) Get a basic programming book, and learn some of the basics
Bruce Byfield, Outlaw Communications
Contributing Editor, Maximum Linux
bbyfield -at- axionet -dot- com | Tel: 604.421.7189
"And if they waste nothing, they can keep their little pile,
And if they say nothing, they will not be on file,
And if they see nothing, no one shall see them,
No one will take down their name."
- Oysterband, "Flatlands"