“All my customers nuclear engineers,” said company owner, “we must therefore its marketing materials as nuclear engineering textbooks.” Business owners who bought into one of the five myths that prevent companies communicate with customers technical.

The first myth is a marketing technique that you must write to your audience. The myth ignores the fact that customers know your product or service in your area, teachers and students. A good teacher talk as much as possible in the existing language and slowly strengthen the students’ knowledge. See how clear and you need to explain to the customer’s product technical section front. Then, write as you speak.

The second myth is the repetition of technical marketing was horrible. Why use a keyboard to the keyboard when you can call an operator interface, human-machine interface (HMI) or input device? However, changing the name of your equipment, screens and document procedures for changing names of streets at every corner more attractive, but the community is really missing. Instead of wondering if the HMI in paragraph 1 is equal to the input device in paragraph 3, the customers, you should focus on messages and technical values. Let your words again.

The third myth is that adjectives and adverbs to convince customers to buy. Sometimes it seems that every company globally unique, state of the art, proactive Equality and produced by experts highest level. But any online search for “advanced” or “unique”. The words put a space should be focused on the details of your product or service. How do you define “unique”? What makes your company an expert? What do you like to meet industry standards or more? Try to write your sales copy without adjectives and adverbs, but with strong data. Make copies to distinguish yourself from the competition and create expertise.

When you find the hardest to explain technical concepts, not words left for a picture. One of the charts, diagrams, videos, photos or pictures to convey technical information more clearly than the number of such items. Myth Four marketing technique that you must use words. Sometimes, the words hit the road.

The final myth but people can create technical products to understand enough to write about. Unfortunately, designers often myopic. Those who are unsuccessful in the marketplace and customer value. Celebration of achievement was very good, but every customer asks, “What are the advantages for me?” That’s the question you must answer the marketing material – and the first answer.

Technical writers, not just write the manual, they write sales copy and marketing. Even in the manual you’re still going to sell the benefits of the product, unless of course you want your readers to spend time in condemning them, “pain” to establish, purchase.

For a copy write effective sales you need to understand the difference between the two, and how to structure your document accordingly.

Features What’s This?

This product feature. For example, if you write a manual for your phone, you can see the camera.

Benefits What is it?

A benefit which the feature is not available to end users. Back to the camera, you can no longer make the phone and camera as you are now in one of its device.

Can not most people care about features, they care benefits. So you have to spend a little time planning for the second document. Create a simple table with the functions listed on the left side and benefits on the right side.

How do I know if the benefit is actually a feature?

It’s a common mistake, somehow slipped into the column characteristics, although the benefit was never vice versa. If you want to test your benefit, try to ask “what is that?” if you need an explanation – to change the column.

Then write how you speak

Do not spend too much time thinking about how to write two, write how you will tell your friends about them and you will not go far wrong. People who speak to them as subjects, rather than lectures.

Use the second person

According to their conversation, people want to find out what it is not for them, for others. So use like a sentence;

“With a big camera in your phone ever, you have to make two devices again.”

“This means the auto focus function that you adjust the lens to get a good image.”

Call to Action

This is important if you want people to use your product you encourage them to do. The action oriented language user permission to start by offering you so always put people to start working with.

“Today Start by taking a picture of you, and sms to your friends!”

Technical writing is a very structured approach to information delivery. The key is to ensure that users are satisfied with your product. This means that you must pass a subject which affects them to be able to see clearly and easily how they can work to the purchase. Here are five simple structure that you can use it to make sure your hand is easy to use.

The hierarchical structure

A hierarchy defines what is most important part of the organization / product / service and then see the rows that continued subordination. If the chart of your business, then you have a hierarchical document. The phone manual is often a good example of this type layout, where the texts of calls and dispatch the most important aspects that come with the entire rest of a large segment thereafter.

Horizontal or circular structure

Many methods currently underway, for example, the sales cycle. The prospect is called, then you sell them something, they become your customer, and then back to the prospect when you have a new product. This arrangement is suitable for almost any business process or software process. This is very useful to the previous requirements or “dependency” for each section of your manual.

vertical structure or a single path

Some processes occur only once and if they’re simple end to end, step by step manner so that the approach used. Diagram on the right is a great way to represent this structure.

linear structure

This complex is only slightly more than single-channel approach, like the novel is the beginning, middle and end. But unlike the novel, there are options in the process that allows the user to get a different end point (or center). This scheme looks more like a decision tree.

Nonlinear structure

You do not read every article ever written technical writing to get this right the wrong? This is because the Internet is a great example of non-linear approach to information. Here, you can swim in and swim to get what you really need, and the type of documents you need to approach it like building a website developed so that users can easily achieve aa they need when they need it. A good approach different tool functions is quite complicated.

One of the many skills necessary technical writer can write test cases. What are the test cases? During the development phase of the product sooner or later, you need to understand whether the product meets as he is scheduled to meet and if it does what you about it.

So how do you develop your test cases? This is a simple guide to describe the process.

General Description

Before you begin, you need a formal system to describe your challenges;

Reference – particularly important for complex products with hundreds of separate tests

Name – For each element, a name that allows it to easily reference

Owner – Who is responsible for working

Full Description – What will you test? How will you test? Remember when you do this, you must test for human error in the process, so for example if you test a database field that requires a digital input, you should also try a negative number, text , random characters, and combinations thereof.

Set Up Report

Here’s a description of how they should be making and testing conditions.

Environment – Where are you going to do and what tools?

Pre-requisite – Need something to do with the environment before the trial begins? (To continue with the database, for example, do you have to load data on the platform before you start?)

Full Script – The step by step guide on how precise you make your case and that every action must be in the test.

Post-Activity Test – Is there something you need to do when you’re done? (For example: delete data from your server?)

Reporting

There are only two things you should describe:

Expected Results: What is the correct output of your actions? If everything worked correctly, you can expect to notice?

Actual Results: What really happened? Where any other comments you made during the process was unexpected or unforeseen (or annoying)?

If you follow the basic descriptions you will not go far wrong when it comes to design test cases, even if you had no previous experience. For simple products could only be a few documents generated for this process, but complex tools such as computer software could be thousands of them, in these cases is a good idea to develop a monitoring tool to enable progress Quick Reference-cycle test.

The experience you earn while working within a team is extremely valuable test your ability to develop an end-user documentation and if the technical writer be willing to be part of the process.

Can not even considered many companies plan documents, and if they did but they see it as an indication of the required chapters and a brief summary of what should be in the negotiations.

Good plan will include all documents of the foregoing, but will cover issues such as who will review this document and when certain information be provided to document, allocation of resources and the resources as well. Careful planning means you will not be able to use the full range of documents checked at the same time, something too much pressure on the review and leave with a full staff of writers who have no connection.

So where to start writing documentation plan

Well, it is natural to start at the end, when necessary, and allow you the time you need to publication and allow time for last change minutes later. You can then know that the most time available for the project.

product information will be documented

Is it based on other products, so you just need information to update, to add and remove features as needed and generally improve the documentation of heritage to the needs of existing ? Or is this new development projects. In this case, you will have a specification of requirements, functional specifications and development plans to determine when the various elements and modules, the product becomes available. With this information, you will be able to plan the structure of the document to produce and, depending on the type of document to be produced, where every state in this section should be reviewed.

Expand Resources

Plan documentation must also achieve all the resources from your own department and other departments involved in the project. Planning reviews so they can enter the calendar is very important, as the length of time can easily be lost if the person you need to consider the document is not available when you planned. And review concerned must understand what is expected of them in the review process.

By the time you are writing your plan documentation, you have a good idea of what they produce, where you can get information from and when, and delays for various components in the review and production stages. Indeed the plan.

The next step is to get your plans reviewed and signed by each team manager will be affected by this. And when each agreement and document the entire plan, ready to change, as this document must remain alive throughout the project. Delay can be easily changed due to the loss of power at the hospital or staff leaving the company, problems develop, or even changing needs.

If you work on a complex project to write the software product manual or detailed instructions for examples of the best sources of information to be content experts or SMEs. Technical writers can sometimes feel a bit surprised by the spirit of calling people to share their knowledge. After all, in the long term will require editors and experts. Here are some simple tips to get the most from your expert:

Preparation

Too often, SMEs do you need a crucial project for members, they may be the primary developer or project manager to ensure that their valuable time. They do not want to lose when you can achieve other objectives with the technical writer is ready. Make a list of questions in advance, and your homework so that it can implement the basic functionality of others before you sit down with the experts.

In addition, you should make sure that the answer to your question in another document that is ready to deliver the project specifications, and any file the user needs help and read. Remember that a major contribution to SMEs throughout the project and do not want to spend too much time by the available data. But do not be afraid to ask questions if you do not understand anything either – after all, if you do get when you write your manual, you will not be able to expect understanding.

Work for scale of time (but if you must drive)

Ideally, you want to deal with SMEs open gladly provide the information you need so you can get your complete user documentation. best way to reach you want to work where they feel comfortable doing, then set up the meeting time. But … because these people the biggest project they often want to duck out entirely to meet you for things they consider most important. Remember that your work is important and can not launch a product (or not) to you without the appropriate documentation if you have tried and failed to work for their calendar, you’ll have a bit arrogant. Regular personal appearances are often required to raise a good way to increase strength and make you move.

SMEs are a source of major projects for technical writers, a great way to work with them to respect their time and use it as an attempt to clarify the last point. You should try to avoid confrontation with them unless absolutely necessary because you can not do your job without help.

As part of the construction of the scope of the first full draft technical writer is needed to remove the author documentation. The document can be included along with “good deal” laid out the basic reasons for implementing the project. This simple guide to create justification for the project.

Problem State

The company has not engaged in for fun projects, they have taken to solve a problem or issue. You must explain the problem clearly and accurately at the beginning of the document so that you can present your solution to this problem.

For example, if you intend to implement the new Human Resources Management System (AD) is a problem, “the HR team now spends nearly 80% of time on administrative tasks to non-productive, reduce significantly the effectiveness the application. ”

State Solutions

Should be a simple statement to define your project. This allows readers to understand what you are proposing.

“We intend that the system be applied to human resource management automation to reduce manual management by half.”

Supply Support Information

The problems and solutions your project will not pose with stakeholders and decision makers, so you must have the appropriate level of information that allows them to support the recommendation.

Examples of the type of information you need:

* Market demand – not always a strong argument, but if you can show your competitors are taking similar system, which clearly indicates that it might be worth considering in your organization.
* Business requirements – In this example, clear operational requirements, the HR team spent most of their time working on tasks for them-specialists and new money.
* Customer demand – what are your customers screaming for? Do not forget to include internal and external customers.
Technological progress * – what is happening in the world around you, it is an interesting story to tell about how computer systems and changing?
* Disclaimer – Do not forget the important obligations to the law, if you can show that your project or would make it easier to meet your needs is a strong case.

You wrote a business case or justification for the project as an important component of bigger project scoping process. Ideally, you should start writing the project lifecycle to help you obtain funding and support. You want to be there too, clearly identify the purpose of your tasks so that staff adopt a clear message.

I’ve had enough experience dealing with technical writers in the automotive industry, which along with space travel, covering almost all types of technical skills known to man.

The people, of course, all engineers and smart enough to walk as far as book smart, and the industry itself is trying to cope with the light from light, some in areas near their genesis in the field of expertise.

The biggest problem I have with most of the people are super smart, but could not pour water on boot if the instructions below. In general, they do not lack people skills and understand the fact that they know more than 99% of its audience, causing the breakdown in communication when they write technical documents.

Technical Writers are responsible primarily to withdraw from the assignment and ask a simple question. “Who am I writing this?” It is very simple, but so ignored.

If you try to write a technical document or statement, or whatever, you can most likely be an expert in the field, or trying to present himself as an expert, the two posts are occupied by mine, if you There’re careful.

Remember people do not care what you know, they care how you know that you can give them, and can not understand the information can not be taken for useful.

Analysis of your target with caution, as they will determine your success. Why should you care if an expert in the field, making fun of your writing as he saw, or did not know that seemed to get more? But the ego, and there is no place for me here, the writer will feel small.

Instead, see the answer to your target audience. Did they meet your writing with great enthusiasm and the show for more? Are they serious questions about the topic that needed some clarification or questions that clearly shows they understand the material and want more?

Once you decide on the level, experience, education and the public wants to desired destination, write to the specification. If you need to write an article on repairing pipes for audiences of DYI, you wrote about reform and disaggregate the information in its simplest form.

However, if your audience a bunch of plumbing, the course material will consist of new applications and new products designed for commercial applications only, and, perhaps, a stunning new methods or products that will greatly enhance their profit margins for residential applications.

Give your audience is not difficult when you have them for identification and they are and what you do not, do you think they are and want.

Sooner or later you will run against any project that requires more than technical writer. You can rely on to successfully approach the creative process-which gives amazing results. Or it could be a case of head banging and ongoing arguments that lead to lower output quality. The only thing different with this approach, the following simple guidelines to make the best effort to the technical staff.

Together the team

The key is to create a winning team diversity. You do not need four authors with exactly the same skills, interests and backgrounds. All you need is a group with a variety of different skills (obviously, there is the possibility that some overlap) and the strengths and weaknesses, giving you more choice of how best to prepare documents perfectly.

Planning

There is no wrong way to plan. Project started with the plan a success rate much higher than those who do not. I would start by asking that each individual member of staff to the project plan and then bring everyone together for a brainstorming session to adopt the plan of the team.

* The basic plan is simple:
* Analysis of audience and task
* Choose one or more topics you’ll cover
* Find the document on the purpose and key audiences
* Reduced admission for jobs
* Develop outline for the document
* Planning research (research on the Internet, access to libraries, journals, etc.)
* Agreement on the general arrangements for storing the information and documents
* Overview of key graphics that can support or subjects
* Allow one style and layout for everyone to use in the project (“style guide”)
* Department of Work and the agreed delivery schedule

Navigation

When should you have finished the planning phase, you can skip to the delivery phase, each team member to have seen (the person responsible for the look and feel, one for graphics, one for the need of technical information, etc. for example) and, ideally, care and share work equally and fairly and can benefit from the strengths of each.

Staying on course

You need to have regular meetings to discuss progress (or lack) of your plan, and, if necessary, you should be ready to distribute the workload to stay on track with your schedule delivery. Played an important role to ensure that staff understand the progress and continue to work together to achieve their goals.

Final Stage

Once you have submitted the documents of staff should be used for “peer review” the work of each section before taking over for user testing. Should their expertise and familiarity with the pieces to allow for thorough review and well polished product. It is always a good idea to make the final project meeting where you can discuss the lessons learned from the writing process to inform the other team you write a project work.

Technical writers come early in their careers often confused myself what is the first technical writing. There are various applications for new writers and often they can not actually see all the “technical”. Thus for professional news here quick list of some commonly requested documents on the make and what they do.

Background Reports

If you do not work for the CIA used, a statement about someone and their lives and their habits. A general background description with a short survey (page 1 or 2) certain aspects of the implementation of technology (eg solar cells used in solar energy transfer). Usually, the generated report available to the public (and pay) specific and singular their applications rather than generic.

Set statement

A better known user guide or manual, the main product of the technical writers and quite clear. They are “how to do x, y and z” a product or service.

Feasibility Study

This study explored whether the special projects or assignments as possible and / or recommended the particular business environment.

Recommendations Reports

The ratio is usually a ratio of 2 or more other activities that companies can choose to continue, with concrete proposals that are considered the best at this time.

Assessment Report

Here, the technical editor will review the results of the specific project and a decision on the benefits and return on investment. Often called the evaluation report, they are an important part of the project lifecycle and can inform future projects and investments.

Research Reports

This is generally a scientific presentation and results of various tasks, such as laboratory tests or market research. The aim of the reports not only on results but also with the methodology and the results are created.

Functional specification document

This document is generally associated with new products and software. You try to capture the features of the victims, in as much detail as possible. Functional specifications are often overcrowded and poor writers are commonly tested as a long-term skills to encapsulate all the requirements.

Proposal

Recommendations are proposals for the project, and you can find thousands of pages for very complex work. Writer task is to create a platform that proposals can be assessed and generally required under the guidelines of the industry and the organization.