INKWELL NEWSWATCH 
Monthly Online eZine  
News And Views For Working Writers

INdex 
 
 INside Scoop
 
 ON THE COVER
 
 INside AUTHORS
 
 COLUMNS
 IN Her Own Write
 INscribe
 Pen IN Hand
 Write On!
 INstruction
 
 WRITER'S LIFE
 Fiction
 Nonfiction
 Screen & Stage
 Poetry
 
 TOOL KIT
 Top 10 Resources
 Advice/Q&A
 Features
 Book Reviews
 Items Of INterest
 Global Offerings
 INside Services
 
 INside CHUCKLES
 Bill The Bard
 The Writer At Work
 Games & Puzzles
 
 FREEdom STUFF
 Classifieds
 Syndication
 Classic eTexts
 Free Software
 IN Banners
 
 ABOUT IN
 Who's IN
 What's IN
 Submissions
 Editorial Calendar
 Advertising
 Join IN's Team
 Contacting IN

IN Front Cover




Search

Learn To Be A Better Journalist

Buy Classic Literature Collections

Acclaimed Screenplay Writing Software

Books On How To Write Fiction

Become A Well Paid Travel Writer



Vote daily and raise our ranking!


TOOL KIT
Items Of INterest
January, 2008


IN Advertising

Part II: What Is Technical Writing?
Precision, concision, and structure
By  Patrick M. Kennedy

Tech writing requires not taking up too much of the reader's time with wordiness.
In Part I, I discussed the general qualities of technical writing. In Part II, I'll discuss more specific requirements of this type of writing as well as the knowledge and educational requirements commonly sought after in technical writing opportunities.
 
Word choice is important. Use jargon (the technical terminology or characteristic idiom of a special activity or group) sparingly. Technical terms and words are helpful shorthand when addressing the documentation to readers within the profession, but may confuse readers without that special background. Use legitimate technical terms to communicate meaning and ideas clearly, but not because they sound impressive. Avoid important-sounding words if simple words that mean the same thing exist. In other words, speak plain English.
 
Write to the point and communicate the information in as few words as possible. Don't take up too much of the reader's time and avoid redundancies or wordiness. In other words, say it once, clearly. Be consistent in style in using numbers, hyphens, punctuation, equations, grammar, symbols, capitalization, technical terms, acronyms, abbreviations, and units of measure. This creates a comfort zone for the reader and avoids confusion.
 
Define acronyms after the first use or as soon as possible in the document (or for larger documents define it again in following sections). Do not assume the reader will know what is meant. If the definition of a word or terminology could possibly be unclear, define it in an index, footnote, or in parentheses. Certain sections of larger documents are often separated for use in other documentation, so the definitions should be available within each section.
 
Break the writing into short sections and paragraphs for easier reading. Creating an outline is a great start; it can directly reflect the headings and sub-headings in the order the information will be presented. If you work with separate SMEs (subject matter experts) for each section, they should be assigned by heading for their input. Short sentences are also easier to read and hold the readers attention rather than long, drawn-out, wordy, overly comma separated, strings of words like this one.
 
Using visuals, (drawings, photographs, maps, graphs, pie charts, bar charts, tables, and schematic diagrams) reinforces the text and makes technical communication more effective. The technical writer must learn to use some basic graphics programs or work with a graphic artist. Generally, it is more time efficient for writers to create the graphics themselves.
 
Get your documentation reviewed. Peer review is one of the most important processes. Everyone who has contributed to the input must review the documentation, or at least the section or information they contributed. All changes should be reviewed after they are made. Management review usually comes after the document is finished, adding a signature of approval.
 
The technical writing process is a simple expansion of common writing and editing practices combined with organization and research. Standards and definitions should be developed at the beginning of the documentation process and then maintained throughout to create consistency. Creating outlines and flowcharts for information and procedures helps to organize unfamiliar material. Developing charts and tables before writing can indicate wholes in the information and be helpful during the research and information gathering phase. Starting with a pre-defined document template or style sheet is a great way to organize and format the information in a consistent and user-friendly way.
 
The technical side of being a technical writer can be quite complex, depending on the particular technology to be documented. The successful technical writer must not only have a command of the English language, but also must be proficient in some of the following user applications: MS Office Suite, Adobe FrameMaker, Adobe PageMaker, EMC Documentum, Macromedia RoboHelp, Microsoft Visio, Adobe Photoshop, Adobe Illustrator, and many more. In addition, the technical writer may be asked to know programming languages such as, HTML, C+, C++, SGML, UNIX, XML, JAVA, or any number of specialized programs related to the particular job.
 
Qualifying education might be a degree in English or Technical Writing, or sometimes the job requirement is a degree in Engineering, Computer Sciences, or even Marketing. The opportunities in the technical writing are many, but the qualifications and processes are varied and intense.

Good luck!
IN Icon


Patrick M. Kennedy has been a professional writer/editor/graphic artist for 30 years. He has published a novel, short stories and poems, articles in magazines, and he contributes a regular lighthearted column to the Senior Wire News Service. Find more about his background, writing samples, and services at: www.abetterword.com 


Sign Up and Use Our New Forums! Voice Your Opinion! Discuss Our Content! Ask for Writing Assistance. Post Your Successes, Queries or Information Requests. Collaborate with Other Writers.

© Freelance Writing Organization - International 1999-2049

Items Of INterest
IN This Issue
Constant Improvement
We're Getting Older! Thank you!
Standing On The Digital Platform
NaNoWriMo Wrap
Official Words From Pop Culture
NaNoWriMo Killed Her
Career Fair For Women
Unotchit LongPen™
Norman Mailer: American Literary Giant
Writer, Inventor, I Am

Support IN
Receive Free Gifts
$20.00 Voluntary Contribution
$35.00 Voluntary Contribution
$50.00 Voluntary Contribution

New Novelist Software


Effectively Manage Your List


Writers Digest 101 Site Award






Your Ad Here

Traffic Swarm For Writers


Hottest Books This Month!

Whose Books Are Turning Into Movies?
Bald Ego
Mouse Over To Pause

Writer’s Block
The path to inspiration starts
Upon the trails we’ve known;
Each writer’s block is not a rock,
But just a stepping stone.

Poetry Is Not
Penned to the page
Waiting for us to admire.
It is only a lonely thought
Caught by tears on fire.

Silent Echoes
A quiet rhyme upon a page
Is what a poet gives;
Some gentle words whispered in trust
To see if memory lives.

Bard From Deadlines
What makes a poem finally work
Is not the time it takes;
It’s how the poet used the muse
To prophet from mistakes.

Be Mused
The art and craft of poetry
Are not so far apart;
The craft comes from the cunning,
The rest comes from the heart.

Fine Vintage
Don’t plant your poem on the page
As though you’re hanging drapes;
It’s shape and flow should come and grow
Like wild summer grapes.

Getting It Write
Writers write what they know best,
Their passions, fears, and dreams;
Writers rarely write about
What other call their “themes.”

Double Vision
A writer’s life is paradox,
It’s more than what it seems;
We write of our reality,
The one inside our dreams.

Poetry
The echo of a promise,
The thunder of a sigh,
The music of a memory,
A child asking why.

Letter Perfect
Twenty six symbols arranged on a page
Can send a soul to heaven or torment it with rage,
Can free a fragile world or hold it in its net--
The power and the magic of the mighty alphabet.

The Write of Passage
The jump from writing just for fun
To getting paid for it
Begins when you first realize
You know you’ll never quit.

Pegasus
It is not the magic of his wings
That sets us free from our bond.
It is the muse within ourselves
That lets our words lift us beyond.

Photo Poet
Consider your mind the darkroom,
Consider your life the lens,
Consider your eye the camera
On whose focus the poem depends.

Rising Moon
A poem is a rising moon
Shining on the sea,
An afterglow of all we know,
Of all we hope to be.

Star Light
Writing a poem,
Reaching a star,
In making good art
We find who we are.

Spider Web
A poem is a spider web
Spun with words of wonder,
Woven lace held in place
By whispers made of thunder.

Re-Verse
The final draft upon the screen,
At last my poem’s through;
A verse of only four short lines--
I rewrote twenty-two!

Read All Of Charles Ghigna's Poetry at FatherGoose.com


Our Own Banner Rotator System
Any banner seen below is either our own or one of our members.
Support the cause - click a banner.


Want Your 468x60 Banner Above? It's FREE For Newly Published Books

© Freelance Writing Organization - International 1999-2049
All Rights Reserved. Copying in any way strictly forbidden.
Our Disclaimer Is Based Upon McIntyre's First Law: "Under the right circumstances, anything I tell you may be wrong."