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.
Shelley Hoose wrote:
>
>
> HI all,
>
> I've recently started a new job in which I am documenting software for
> programmers. It's Java with SQL Server at the back end. I don't really
know
> anything about this stuff <snip>
Shelley,
Try chatting with the folks who developed the software you are documenting.
Most software developers today are using Software Developer's Kits (SDKs),
tools suites, etc. which usually provide a programming environment with a
GUI interface (for Windows platforms anyway). There aren't many diehards
left who use just an ASCII editor, a compiler and a linker.
Ask them how they use the doc for the tools they are using and look over
that doc set yourself. It may provide good insight into how the users of
what you are documenting like to work. Generally speaking developers use
doc for reference. They've figured their way around different kinds of took
kits, interfaces, developer's utilities, etc. and just "want the facts."
Good luck,
Steve MacDonald
Aspect Telecommunications, Inc.
