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.
> The ability to read code. It can start as basic as knowing actual coding of HTML, but trying to find some lower-level or continuing education college programs you can take to learn the basics of some coding (like Java) is a help, even if you don't plan on switching from Tech Writing to engineering. Knowing HTML coding cuts your dependency on tools to help you convert things over to HTML formats, and a general knowledge of code structures (and how not to break things) has always been a great help to me. Can I quickly program Java code? No. But I can look at it and troubleshoot where there may be problems, and my developers can be certain I know enough where I'm allowed to poke around the actual code for the product to correct things like grammar that is part of the code, and just see what the code is actually doing, without breaking anything else.
I'd go one step further and say once you can understand code, you need
to know what to do with it. Should you be able to create sample
applications? If you're documenting APIs and SDKs, then ideally that
answer is "yes".
Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days. http://www.doctohelp.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-