A directory of resources inthe field of technical communication (and technical writing).

Technical Writing

151-174 of 1,149 found. Page 7 of 46.

About this Site | Advanced Search | Localization | Site Maps

« PREVIOUS PAGE 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25  NEXT PAGE »

Technical Writing, a form of technical communication, is a style of formal writing and business communication, used in fields as diverse as computer hardware and software, chemistry, the aerospace industry, robotics, finance, consumer electronics, and biotechnology. Good technical writing clarifies technical jargon; that is, it presents useful information that is clear and easy to understand for the intended audience.



DITA and Riding a Bike

As a technical communicator (writing about software), how do you deliver content just as the user needs it? Over my years as a writer, these points have helped me.

Lowe, Karen. DITA Chicks (2010). Articles>Content Management>Technical Writing>DITA


Dividing It Up, With Any Crowd

When you think of the crowd, you probably think about a specific mass of people who use the software and hardware that we document every day. The interesting thing about the crowd is that it doesn’t necessarily mean people outside of the enterprise in which you’re working. There are people in your enterprise who can do a lot to help you with the documentation, too. Developer, product managers, QA analysts. They all have knowledge that you can and should tap.

Nesbitt, Scott. DMN Communications (2009). Articles>Documentation>Social Networking>Technical Writing


Do Community Efforts Work?

Some of my projects include community-involved documentation. When you work for a church, it’s not hard to find dedicated members willing and committed to sacrificing a few hours for a higher cause. To harness community efforts, I gathered up a large pool of volunteer names and formed a listserv. I communicated project needs with the listserv members and asked for help. Despite some contributions, the majority of volunteers are hindered by too many obstacles — access to information, time, standards, and more — to contribute much. As such, I’ve begun to change my expectations from content creation to content review and feedback.

Johnson, Tom H. I'd Rather Be Writing (2010). Articles>Documentation>Community Building>Technical Writing


Do Indian Technical Writers Need Professional Courses?

After carefully studying the various areas that can be touched upon, we identified performance and the need of systematic Technical Writing education as the focus for our research. We prepared two surveys and then hosted them on SurveyMonkey.com for 50 days. The first survey was for Technical Writing Managers (Hiring Managers) and the second was for Technical Writers. The first survey was completed by 14 participants whereas the second survey was completed by 185 participants.

Pandit, Makarand M. and Gyanesh Talwar. Indus (2010). Articles>Education>Technical Writing>India


Do Technical Authors Do Anything Important?

Often, the more important the job, the more important it is for people to have clear information to hand, explaining what to do and how to do it.

Pratt, Ellis. Cherryleaf (2012). Articles>Writing>Technical Writing


Do Technical Writers Need an International Standard for English-Language Spelling?

He demonstrates how ministers of state who speak different languages often choose English as the most convenient language of communication. He cites the 11-nation European Central Bank in Frankfurt as a typical organization that works only in English. And he notes that many of the journals published by respected international organizations such as the Pasteur Institute also are published in English. TC-Forum is another example.

Blicq, Ronald S. TC-FORUM (1999). Articles>Style Guides>International>Technical Writing


Do Technical Writers Need Certification?

Personally, I’d rather see it done as a series of courses and tests covering major areas of the profession. Basing it on a portfolio immediately cuts out a large portion of the writing community who produce proprietary material. Most writers would probably be better off pursuing an advanced degree like an MA from a university that offers a technical communication program.

Soltys, Keith. Core Dump (2010). Careers>Certification>Technical Writing


Do We Need to Hire a Salaried Technical Writer or Should We Go With a Freelancer?

You are a high-tech/Bio-tech company and your first product is nearing release. The product requires documentation and you ask your self what are our options? Before deciding you should consider these factors.

Hurwitz, Charles. Freelance Technical Writing in Israel (2009). Careers>Management>Freelance>Technical Writing


Do You Like Jigsaw Puzzles?

I have been pondering technical editing processes. Most notably, as I play on my iPad putting together jigsaw puzzles made from my favorite vacation photos, I have pondered whether most technical editors like putting together jigsaw puzzles.

Corbin, Michelle. Corrigo (2012). Articles>Editing>Technical Editing>Writing


The Doc Whisperer

Doc whisperers are more commonly known as "senior technical writers", but what's in a name anyway? So if you want to be a great tech writer—start whispering.

Brooke, Andrew. Tech Writer's World, A (2009). Articles>Documentation>Technical Writing


Docs Aren't Code

In the world of development, the need to track bug reports and enhancement requests are a given. But they're not generally required for documentation, in the way they are for code Quite the reverse. For documentation, bug reports and enhancement requests provide little benefit, and generally impede progress. This post compares documentation and code, showing why bug reports and enhancement requests are so vital to the code base, and at the same time why those reasons simply do not apply to documentation.

Armstrong, Eric. Sun Microsystems (2008). Articles>Documentation>Programming>Technical Writing


Document Hack (A Technical Writer's Journal): Changing Bosses

Switching bosses within the same company is not an entirely smooth process. On the day of the crossover, I showed up to work and discovered my badge and my email deactivated. It took most of the day to get security to reactivate my accounts.

Hewitt, John. Writer's Resource Center (2004). Careers>Writing>Technical Writing


Document Hack (A Technical Writer's Journal): First Day

Rule number one for a contractor is to never panic about what happens your first day. First days are naturally chaotic, and often companies are not fully prepared for you. Because contractors are usually brought in to solve a particular problem, the people are anxious to get you started, but companies, especially large ones, are not geared for quick action.

Hewitt, John. Writer's Resource Center (2004). Careers>Advice>Writing>Technical Writing


Document Hack (A Technical Writer's Journal): Interview and Negotiation

My face-to-face interview with the company was similar to my phone interview. So similar, in fact that more than once I found myself answering the same questions I had answered over the phone. They did throw a couple curve balls at me, however. The strangest question I was asked was, 'If we called your references, what would they say about you?' I was unprepared for this one, and I ended up talking more about my references than about what they would say about me.

Hewitt, John. Writer's Resource Center (2004). Careers>Interviewing>Writing>Technical Writing


Document Hack (A Technical Writer's Journal): Phone Interview

When I originally spoke to the recruiter on the phone, she gave me a brief description of the job and asked for my rate. We negotiated the rate for a few minutes and came up with an acceptable number ($25 an hour) and she sent me an e-mail with the full job description and a short agreement asking me to confirm her representation and my rate. I sent back my confirmation and that was it for a while.

Hewitt, John. Writer's Resource Center (2004). Careers>Interviewing>Writing>Technical Writing


Documentation for Consumer Products: Give it a Chance

Documentation for consumer products gets a bad rap. Often, it's deserved. But you can't paint all documentation with the same brush. This post looks at the good and the bad in consumer documentation, and at the elements which can make that documentation good.

Nesbitt, Scott. DMN Communications (2009). Articles>Documentation>Technical Writing


The Documentation Scene

Funny thing, documentation. Ought to be easy enough, surely? So why the disappointing results? What IS the elusive spark which distinguishes the professional author from others who put their hand to the pen (keyboard)?

Mobbs, John. ISTC (2002). Articles>Documentation>Writing>Technical Writing


Documentation Solutions for Complex Tools: Task-Based Design at the Cross Roads   (PDF)

For most of the technical writing community, task-based documentation has become the panacea for presentation of end-product document (in any of its myriad forms including traditional linear manuals and online help). We believe, however, that applying this method to a complex tool, (for example, a software tool without a Graphical User Interface), challenges the task-based approach.

Swallow, Lisa and Matt Laney. STC Proceedings (2004). Articles>Documentation>Writing>Technical Writing


Documentation Sprawl, or What Happens When There's No Documentation Plan

The documentation strategy over the course of some development projects has, unfortunately, resembled a building with several add-ons rather than a single, unified structure—wings added, walls moved, different materials used. Where I live, no one builds like this, except in residential neighborhoods and on college campuses. This approach doesn’t exactly make for a consistent experience for users. It’s what I’d call documentation sprawl.

Minson, Benjamin. Gryphon Mountain (2010). Articles>Documentation>Planning>Technical Writing


Documentation, Quick and Dirty

what can you do if you don’t have a technical writer or the standard tools? You just might have to go quick and dirty. Quick and dirty documentation is a band aid, no doubt about it. But it’s better than nothing. This article presents some thoughts about ways to deliver documentation quickly and cheaply.

Nesbitt, Scott. DMN Communications (2011). Articles>Documentation>Technical Writing


Documenting Open Source Software

I love reading different community perceptions of both FLOSS Manuals, where we write open docs for open software. I’m also lurking on mailing lists and forums where open source projects are figuring out documentation needs for their users. Forgive me if I ramble a bit, but I’ve been thinking about these concepts lately while discussing them with other writers.

Gentle, Anne. Just Write Click (2010). Articles>Documentation>Technical Writing>Open Source


DocuMentorG Columns

Columns on technical writing. Continuation of the column written from 2001-03 for IT People.

Kamath, Gurudutt R. Topica (2004). Resources>Mailing Lists>Writing>Technical Writing


Does a Technical Writer Need to Understand Web Design?

The certificate in web design? Not necessary. But a working knowledge of HTML and CSS? Yes, critical, because everything is moving (or already moved about 10 years ago) to the web, including documentation. If you create help in a print environment only, chances are you still publish the PDF on a website somewhere.

Johnson, Tom H. I'd Rather Be Writing (2010). Articles>Writing>Technical Writing>Web Design


Does DITA Make You Dumb?

There are at least two broad categories of technology that managers often confuse. The first is technology that replaces a particular skill. For example, the cash register at a McDonalds has technology that relieves cashiers from doing math, so they can hire people who are not skilled in math. The second is technology that allows a skilled practitioner to be more productive. For example, the computer makes it possible to write and edit text much more easily than a typewriter, but it won’t make a bad writer better.

Hamilton, Richard. Managing Writers (2009). Articles>Management>Technical Writing>DITA


Does Having a Blog Make You a Writer?   (members only)

For the techno-savvy TechRepublic member, writing in some form or fashion is an almost daily occurrence. But how effective is your communication? In this interview, author Barry Rosenberg shares his thoughts about the current state of technical writing skills.

Kaelin, Mark. TechRepublic (2005). Articles>Interviews>Technical Writing>Blogging



Follow us on: TwitterFacebookRSSPost about us on: TwitterFacebookDeliciousRSSStumbleUpon