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:Core Skills for Technical Communicators From:Alexander Adrian Szczepaniak <szczeaa -at- ANUBIS -dot- NETWORK -dot- COM> Date:Fri, 15 Mar 1996 10:34:51 "CST
Hi all! Did someone mention something about TC core skills?
I recently compiled the lists below. It doesn't cover everything (believe me; I
can go on and on) but I find it useful explaining what I do to my clients,
friends, the IRS and so on:
Skills
Ability to assimilate technical information quickly
Ability to use illustration, writing and other communication modes effectively
High interpersonal skills (dealing with clients and engineers)
Excellent adaptation rate
Familiarity with wide variety of writing approaches (journalism, reports,
training)
Ability to quickly pull the most useful information out of technologies
Understanding of wide variety of worker/user attitudes
Excellent writing skills
Excellent interviewing skills
Instinct for spotting inefficiencies
Instinct for calling in experts and asking appropriate questions
Instinct for problem definition
Ability to manage dysfunctional folks
No fear of technology
Knowledge of roles in publications: proofreaders, illustrators, editors, et al.
Willingness to exploit all media to get communication done correctly
Knowing how to maintain consistency, use user cues, throw obsolete styles and
printing conventions out the window
Knowing that Writing does not equal Technical Writing. English does not equal
communication. Tools do not define skills or ability.
Knowing what level of detail is appropriate for your audience
Good at estimating metrics
and so on
tasks:
Meeting with Core Team, Engineers, Marketers, Designers, et al. to establish priorities for documentation (i.e., manuals, guides, brochures and so on).
Lining up support resources: design specs, equipment specs, module specs, feature lists, library resources, CDLs, ECNs, marketing material, previous versions of the document being worked on, meeting minutes, and so on.
Interviewing experts: Engineers, Marketers, Designers, Testers, HelpDesk, Trainers, external experts, and so on.
Identifying primary and secondary functions of the system or machine being written about
Identifying the major stages in a Process being written about (examples include TQM, network management, and Re-engineering)
Developing a user or audience profile--who is using the system, machine or process?
Determining factors affecting physical production of document: internal requirements (such as part numbers, file location, printer deadlines), machine requirements (what graphic formats to use, system speed and memory limitation, what program to develop in)
Learning to use the machine, process, or system
Preparing an overview of the program, determining its flexibility and limitations
Brainstorming and developing document design ideas
Determining the logical arrangement of chapters and sections
Deciding indexing methodology (how to structure references and glossaries)
Deciding document conventions (how will it look, phrasing, formatting, assumptions about user knowledge level)
Establishing the interrelationship of document with helpfiles, marketing brochures, training materials
Determining Illustrations and tables needed
Providing time estimates
Obtaining approval for design and conventions of document