Category: Documentation

Why Should a Technical Writer Be Familiar With Design Specs and Testing Specs?

spec sheetAuthor: Ugur Akinci

Specification (spec) sheets are like maps for the captain of a ship or the blueprints for an architect. No project can start without first putting the specs on paper.

Here are two spec sheets with which a technical writer should be familiar:

Design specs – This is a document that builds on and follows closely the “functional specs” document. It basically describes what a product should look like when it is manufactured. It takes all the functions and detailed features specified in the functional specs sheet and translates them into a visual language.

For example, if the functional specs describe a configuration function, the design specs describe the button or the navigational link that should launch the configuration interface; what it’s colors and fonts should be; where exactly the fields and buttons should be placed on the dialog boxes; etc. Design specs may also specify a product’s maintenance schedule and the service requirements, etc.

Testing specs – This document specifies the unit and system integration testing that needs to be performed on the product before it is released to the market. This document sometimes also includes the testing scenarios (or scripts) that the test engineers should follow step-by-step to reveal the weaknesses and discover the bugs before consumers can find them.

Technical writers sometimes contribute directly by writing such testing scripts and actually participating in the tests as well. Testing specs and the testing results are precious since they reveal for a technical writer all the vulnerable points of a product and become the input for the Release Notes that accompany every major release of a product, especially in the software industry.

If you are interested to read more about technical writing as a career and how it can help you earn a steady living, visit http://www.learntechnicalwriting.com. 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 today and claim your free report “How Much Do Technical Writers Make?”

About the author

Dr. Ugur Akinci is a Fortune 500 Sr. Technical Communicator http://www.technicalcommunicationcenter.com/

Article Source: http://EzineArticles.com/?expert=Ugur_Akinci
http://EzineArticles.com/?Technical-Writing—Why-Should-a-Technical-Writer-Be-Familiar-With-Design-Specs-and-Testing-Specs?&id=1894071

Five Rules For Subject Verb Agreement

argumentAuthor: Warren Wong

When speaking or writing English, it is important to make the subjects and the verb agree. Let’s go over some rules using basic sentences. These rules will help you choose the correct verb based on the subject.

Rule #1: Subject usually left of verb

Before you know which verb to use, first you need to know what the subject is! As a general rule, the subject is usually immediately to the left of the verb.

Example: That tree grows fast.

Here, the subject is immediately to the left of the verb. The verb is “grows”, making the subject “tree”.

Example: Sometimes dogs bark for fun.

The verb here is “bark”. As you can see, the subject, “dogs”, is immediately to the left.

There are exceptions to this rule. One big signal of a sentence where the verb comes before the subject is when the sentence starts with “There”.

Example: There are apples everywhere.

“Apples” is the subject. The verb, “are”, comes before the subject.

Rule #2: “Or” use singular, “and” use plural

This is for sentences with two or more subjects. If the subjects are connected with the word “or”, you want to use a singular verb. If they are connected with the word “and”, use a plural verb.

Example: Tom or Sally is picking it up at noon.

Our two subjects, “Tom” and “Sally”, are connected by the word “or”. Because of this, our verb needs to be singular (is)

Example: Tom and Sally are picking it up at noon.

By connecting our two subjects with “and”, we now use a plural verb (are).

In these examples, the subjects were singular. What happens if one of the subjects is plural?

Rule #3: When in doubt, verb agrees with nearest subject

When a singular and a plural noun are connected by the word “or”, the verb should agree with the nearest subject. Remember, “are” is used with plural while “is” is used with singular.

Example: The players or the coach is in the gym.

Example: The coach or the players are in the gym.

Let’s look at two examples that use verbs different than “is” and “are”.

Example: Tom or the cats run for dear life.

Example: The cats or Tom runs for dear life.

Rule #4: Don’t become confused of the subject

This can be a tricky thing to remember. Some sentences have a phrase after the subject but before the verb. These phrases can make identifying the subject an adventure. In the below examples, the subject and the verb are in italics. Notice how the words in between could change the verb usage if they were falsely identified as the subject.

Example: The quarterback, not to mention the rest of his teammates, is worried about tonight’s game.

Example: My neighbor with all the birds is running for Sheriff.

Example: The dogs who watch the cat are getting tired.

Example: That girl who likes the flowers jogs twice per day.

Example: One of the trees is dying.

Rule #5: Everybody is singular

Although they sound plural, subjects such as everybody, anybody, no one, somebody, nobody, each, either, and neither are singular and use singular verbs.

Example: Everybody who came tonight is to be commended.

Example: Anybody is welcome to attend.

Example: Nobody I love came to my party.

Example: Either will do.

Example: Each of these cars is a fine choice.

As you work towards mastering English, there will be times of frustration. But don’t give up! Just remember, practice makes perfect.

About the Author

Warren Wong writes for 1-language.com, a website dedicated to helping people Learn English.

Article Source: Articles Engine

Learn Technical Writing – Exercise – Consistent Use of Numbers, Abbreviations and Symbols

numbersAuthor: Bryan S. Adar

Ralph Waldo Emerson (19th century American essayist) said that a foolish consistency is the hobgoblin of little minds. He thought that what he called a great person doesn’t have to think consistently from one day to the next. Maybe so, but a great tech writer does need to think consistently – and write consistently, too.

Being consistent is very important in all types of writing from memos to technical manuals. The area we’re looking at today has to do with using numbers, abbreviations, and symbols. Each of these elements can be written in a variety of ways. For example: five feet, 5′, 5 ft., five ft. They all mean the same thing. Which one a writer uses is important, but using them in a consistent way is just as important. Five feet in one place should match five feet in another. This is poor usage: Five feet is enough space in front, but 5 ft. doesn’t allow enough space behind.

A style that is often suggested is that in documents where a word like foot shows up only once or twice, it’s written out. In documents where it appears multiple times, ft is better usage. That may be the writer’s call, or it may depend on the client’s style guide.

In the following sentences, it’s up to you. Use the style you prefer, but be consistent. Then, write a “rule” or “rules” that cover the situation. We’ve provided one preferred way of writing each sentence.

Example: We’ll arrive on 25 April and depart 06/05. We’ll arrive on April 25th and depart on June 5th. Rule: Be consistent in how you write dates. Rule: It’s safer to spell out month names.

  1. The winning fish weighed 16 1/2 lb and was about 1.75m long.
  2. These units are called MHz.
  3. The base units come in boxes of ten @ a quarter each or $2 per box. measurement, or of specific importance.
  4. 27 hourly employees will be involved in the transfer.
  5. Check the % of items with values of less than .75.
  6. The shipment will arrive between 11:00 am and 14:30.
  7. Be sure the space is at least 6 1/2″ wide, 5.75 in. deep, and 11 inches long.
  8. Use 300 pounds of type one, one thousand lbs of type 2, and 2 thousand kg of type three.
  9. We need 50# of #5 widgets stet.

Exercise – Answer

  1. The winning fish weighed 16 1/2 lb and was about 1.75m long. The winning fish weighed 16 1/2 lb and was about 5 3/4 ft long.
    Rule: Don’t mix metric and English measures.
  2. These units are called MHz. These units are called megahertz (MHz).
    Rule: Write out the full word with the abbreviation in parenthesis the first time it’s used.
  3. The base units come in boxes of ten @ a quarter each or $2 per box. The base units come in boxes of 10 at the cost of 25 cents each or $2 per box.
    Rule: Use numerals when the amount is a key value, an exact measurement, or of specific importance.
  4. 27 hourly employees will be involved in the transfer. The transfer will involve 27 hourly employees.
    Rule: Don’t begin a sentence with a numeral.
  5. Check the % of items with values of less than .75. Check the percent of items with values of less than .75.
    Rule: Use symbols only with specific values, not as a substitute for the word.
  6. The shipment will arrive between 11:00 am and 14:30. The shipment will arrive between 11:00 am and 2:30 pm.
    Rule: Don’t mix 12-hour and 24-hour time designations.
  7. Be sure the space is at least 6 1/2″ wide, 5.75 in. deep, and 11 inches long. Be sure the space is at least 6 1/2″ wide, 5 3/4″ deep, and 11″ long.
    Rule: Use abbreviations consistently. Rule: Don’t mix decimals and fractions.
  8. Use 300 pounds of type one, one thousand lbs of type 2, and 2 thousand kg of type three. Use 300 lb of type 1, 1,000 lb of type 2, and 4,400 lb of type 3.
    Rule: Use numerals when the amount is a key value, an exact measurement, or of specific importance. Rule: Don’t mix metric and English measures.
  9. We need 50# of #5 widgets stet. We need 50 lb. of no. 5 widgets immediately.
    Rule: Write out symbols that have more than one meaning.
    Rule: Avoid abbreviations that are not universally familiar.

If you can write a simple sentence in English 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 $60,380. Freelance technical writers can make from $30 to $70 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

Article Source: http://EzineArticles.com/?expert=Bryan_S._Adar
http://EzineArticles.com/?Learn-Technical-Writing—Exercise—Consistent-Use-of-Numbers,-Abbreviations-and-Symbols&id=1458926

Effective Content Writing

writing-with-penThe field of content writing serves as a very important feature in a website. The main reason people visit the site is to search for information on different goods and services. Audiences will be satisfied if they get informative and satisfactory content on one’s site. Besides this, a site needs to be well designed as well with information-rich content in order to drive more traffic.

Easy and simple language is the prerequisite of any content. There are a few pointers that need to be reminded at all costs in order to excel in the field of content writing. The first and foremost point is to ensure that the language of the content is in accordance with audiences for whom the articles, reviews or blogs are meant.

For example, if a content writer intends to write a promotional article, then he needs to know the nature and services offered by that particular business and its technical terms in order to make the best promotional style content. Also, a very simple and easy to understand language needs to be used in writing content for the sites so that even the lay man can easily get to know what the content is all about. The writer needs to think from the place of the reader and offer complete information.

Essentials of content writing – authenticity, organization and numbering.

Organization of content is also very crucial and includes proper designing and formatting of the information gathered from various sources. The writer can write an entire article in a single paragraph or can even make the content easy to read by arranging the headings. The relevancy of pointers needs to be properly handled so that the audiences can analyze distinction of paragraphs.

Numbering and bulleting needs to be used in the content to highlight the most important points. This will automatically make the article effective along with breaking the visual monotony.

It is wise to use the conversational language as it helps the readers to feel more involved in content thereby motivating them to continue reading the article.

In addition, the authenticity and originality of the content needs to be considered wisely because offering wrong or prejudiced information to readers can in turn provide negative or incomplete impact.

Needless to say, to be a successful and popular content writer, it is very imperative to have that passion and flair to write. Until the writer is extremely passionate about his or her job, they can produce only mundane and dull content. so, follow these simple and beneficial tips in order to write exceptional content for the targeted audiences.

About the Author

Visit sem-infotech.com for content writing services, ppc management and professional seo services.

Article source: http://www.articler.com/

WordPress Themes