Showing posts with label Technical. Show all posts
Showing posts with label Technical. Show all posts

Saturday, December 1, 2012

Technical Writing - The Difference Between a Process and a Procedure

In Shakespeare's Henry IV, Part 1, Act III, Scene 1, in an argument about how to divide a piece of land, one character says that he'll "cavil on the ninth part of a hair." Cavil means to quibble over an unimportant point. Even better, it's a really annoying and trivial objection. The reason for mentioning this is because there's often a fine line between caviling and getting it technically right. Here at The Tech Writer's Tool Kit, the general view is that every word has a specific meaning and no two words ever have exactly the same meaning. Is it a cavil to insist that there's an important difference between a procedure and a process? They both mean a way to get something done. Is changing a tire a process or a procedure? Did you just go through the (process or procedure) of refinancing your home?

Procedure - The dictionary gives the etymology of procedure as a French word, procédure, from proceder which means to proceed. To proceed is defined, simply, as to go forward and procedure is defined as a manner of proceeding. We have to go beyond simple definition to usage. In American English, the word is used, most often, to designate a unique type of undertaking. So, we have medical procedure and nomination procedure. A procedure, then, is a single activity, consisting of multiple steps, performed to accomplish a specific outcome. - This is the procedure we use to elect our officers.- The doctor said the procedure is simple enough to be done in his office.- It's a long and complicated procedure that must be performed carefully.

Process - Starting with the dictionary for the etymology, we do kind of a loop around to find out process comes through Middle English and Old French from Latin prMcdere that means to advance or proceed. Sounds a lot like procedure. But, the definition of process shows a difference. It says a process is a series of actions that bring about a result. In most cases, that result is a completed procedure. The distinction holds up in general usage in a number of fields. For example, we talk about a hair coloring process, events now in process, and processing an order. In Law, process is defined as the whole judicial proceeding (procedure). In Engineering, the steps in changing iron into steel is a process. In Computer Science, it means performing operations on data, which is done by a processor.

Technical Writing - The Difference Between a Process and a Procedure

Based on general usage, then: - a procedure is a total operation - the complete set of actions - that results in some desired outcome- a process is the series of individual steps within the procedure that is followed to achieve the outcome The difference is that you must follow a process in order to complete a procedure. That would mean that saying, "The process of getting a haircut is boring" doesn't mean the same as saying, "The procedure of getting a haircut is boring." It depends on whether you're saying that the individual steps are boring or the whole operation boring. Two different words: two different meanings? We think so. What about you?

Technical Writing - The Difference Between a Process and a Procedure
Check For The New Release in Health, Fitness & Dieting Category of Books NOW!
Check What Are The Top Cooking Books in Last 90 Days Best Cheap Deal!
Check For Cookbooks Best Sellers 2012 Discount OFFER!
Check for Top 100 Most Popular Books People Are Buying Daily Price Update!
Check For 100 New Release & BestSeller Books For Your Collection

If you can write a simple sentence and organize your thoughts then technical writing may be a rewarding field. You can easily make it a second income stream in your spare time.

According to the U.S. Department of Labor, the average salary for technical writers is ,380. Freelance technical writers can make from to per hour.

The field of technical writing is like a golden city. It's filled with wealth, rewards and opportunities. After learning technical writing you can branch out into business writing, marketing writing and communications writing. All of these can become additional income streams.

But to succeed you must learn how to market yourself to clients. You have to prove to them that you are an invaluable asset. That's where ProTech - Your Fast Track to Becoming a Successful Technical Writer can help. It's a technical writing course that does two equally important things:

1. It teaches you the skills to become a technical writer in the shortest time frame. You'll learn to create manuals, procedures, tutorials, processes, proposals, spec sheets and other documents that businesses need.

2. It shows you how to market yourself to clients so you can start your income stream as soon as possible.

In fact, you'll get a complete marketing toolkit which has templates and technical writing job sites to get started immediately!

You can download two sample lessons by clicking the link below.

This could be your chance to create a prosperous future.

Click the link below to download your two sample lessons.

[https://www.techwritingcourse.com]

mobile phone watches Buy 2008 2010 Mitsubishi Lancer Without Turbo Radiator Buy Auburn Gear 5420113 High Performance Series Differential Best Price Golf Cart Ultimate Light Kit Upgrade

Tuesday, November 27, 2012

Technical Writing - How to Format Your Technical Documents Consistently With a Template?

Consistency of a technical documentation is what creates that subliminal sense of trust and confidence in the end-users.

Someone once quipped: "it ain't technical documentation if it ain't boring." This of course is not literally true since I always found technical documents very interesting indeed.

However, this quip reflects the truth that a technical document must be "boringly consistent" in order to be taken seriously. I could also say "religiously consistent" as the phrase goes, but I thought I might inadvertently offend someone and that certainly is not my intention here.

Technical Writing - How to Format Your Technical Documents Consistently With a Template?

Just ask yourself: would you trust an airplane maintenance manual that has missing page numbers, has chapter headings printed in different fonts and sizes, has differently formatted figure captions for consecutively printed figures (like "Figure 2-14" on one page, and "FIGURE 15" on next)?

Consistency all starts with a document TEMPLATE.

It is harder to shift between different page templates if you are using MS Word as your main text editing program, and much easier if you are using Framemaker or InDesign since the last two are built on the "Master Pages" concept. But a page template is what you definitely must have.

When you have a template, you have consistent margins, sidebars, headers and footers, for starters. You have consistent page numbering and column, and page gutter(s) if you have more than one column.

If your text editor allows you to create Master Pages, I'd recommend you to create a document template starting off with the following 5 types of pages (assuming you are writing a book):

1) Front Cover.
2) First Page.
3) Right Page.
4) Left Page.
5) Back Cover.

And it wouldn't hurt at all of you design templates (Master Pages) for the following types of special pages as well:

6) Front Matter.
7) TOC.
8) List of Tables and Figures.
9) Index.

Have a template first before structuring your information. It's a must. "Don't leave home without it," as one credit card commercial used to say.

Technical Writing - How to Format Your Technical Documents Consistently With a Template?
Check For The New Release in Health, Fitness & Dieting Category of Books NOW!
Check What Are The Top Cooking Books in Last 90 Days Best Cheap Deal!
Check For Cookbooks Best Sellers 2012 Discount OFFER!
Check for Top 100 Most Popular Books People Are Buying Daily Price Update!
Check For 100 New Release & BestSeller Books For Your Collection

If you are ready to read more about what technical writing is all about and how it can help you earn a steady living, visit http://www.learntechnicalwriting.com and claim your free report "How Much Do Technical Writers Make?" You might be pleasantly surprised with what you'll find out. Join the thousands who are already helped and inspired by this information provided by a Fortune 500 Senior Technical Writer. Visit us now.

watch mobile phone Cheap Deals Mason 5C025 Pad Anti Vibration Best Price Golf Cart Ultimate Light Kit Upgrade Buy Auburn Gear 5420113 High Performance Series Differential