Technical Copywriter - Turn technical help materials into user-friendly documents

We are implementing an internal helpdesk portal.

As part of this delivery, it has been identified that the knowledge materials (articles, FAQs, Quick Reference guides, help pages etc) designed to help end-users with internal systems are too technical in nature and do not meet their objective to allow users to quickly and easily find answers to the problems they are looking for.

This project is to review and rewrite the knowledge materials, by putting the end-user at the core of the requirement, to deliver user-centric self-help documentation.

Content Creation Principles

1. Reduce freeze-flight-fight-forfeit

Users under stress go through an emotional state where they first freeze, then potentially flee, or fight, and finally forfeit. Documentation will be produced with the assumption that users will read it in a state of annoyance, anger, and tension. This means readers will scan, jump around, and read quickly. The documentation will be structured with clear headings, sub-headings and paragraph structures that will allow the user to consume content more easily.

2. Maximise readability

Sentences will be simple, clear, and easy-to-understand, especially as the concepts get more complex. In fact, the more complex the material, the simpler the sentences need to be.

Beautifully designed

Aesthetic style is important to users when consuming content.

Documentation produced will be

 9-12pt font, in an easily read font such as Arial or Calibri

 10-12 words (55 characters) per line

 Dark text on light background (black on white)

 Have consistent heading and sub-heading styles, call-out boxes, references and links across all documentation.

3. Goldilocks length

The larger and more complex the system, the greater the strain on the user. The greater the strain, the lower the user's success. In many cases, documentation that is too massive deflates the user from even trying at all. Users' attention will be focussed on what matters by reducing extraneous information. We are looking to produce goldilocks documentation (“just right!”)

We will eliminate content that is merely "noise" as opposed to meaningful information.

We will document the information that most users need to know, and omit info that applies to a tiny subset of users (edge cases or obvious information). Adding it into the main documentation dilutes the information for the majority. Documentation produced will correctly sized with this principal in mind.

4. A picture paints 1000 words

Pictures combined with text provide users with better comprehension and recall. Especially as users quickly scan a page, pictures (simple, concrete, and reinforcing a clear message) will help users to understand the material better.

5. Use personas

We will create composite descriptions of users based on real research to guide decision-making about design. Documentation will be created with these personas in mind.

6. Use business champions

We will reduce the number of errors, gaps, and mistakes by involving a number of unbiased experts to influence the content. Even when using our industry leading business and technical copywriters, we are outsiders to your business environment, and not as familiar with the industry context of the product nor as versed in the technology as engineers and QA. As such, we will involve the input of Business Champions as much as possible to increase the quality and comprehensiveness of the documentation.

7. Develop iteratively

Developed documents will usually start out simple and get increasingly more detailed and refined with each additional iteration. It often takes multiple iterations — through reviews, user feedback, testing, etc. — to achieve a high level of quality. We will employ an iterative approach to ensure these standards are met.

8. Use rich and interactive media

Evner: Copywriting, Teknisk Forfatning

Se mere: adobe framemaker technical writing software tools, technical writing tools free, adobe robohelp technical documentation, adobe robohelp technical writing software tools, technical documentation authoring tools, adobe robohelp technical writing, technical writing tools 2017, technical manual writing software, interview questions technical copywriter prepare technical manual, technical copywriter bucks, technical copywriter motorcycle, technical copywriter thesis, technical copywriter information security, freelance technical copywriter durham uk, freelance technical copywriter for writing data sheets see more at https www alhidden com writing datasheets sthash nkkoumvq dpu, technical copywriter, junior technical copywriter sandton, technical copywriter cape town jobs, technical copywriter other, agentur technical copywriter wien

Om arbejdsgiveren:
( 0 bedømmelser ) Fulham, United Kingdom

Projekt ID: #18829235

14 freelancere byder i gennemsnit £19/time for dette job


I excel in the fields of technical writing and content management projects. I have spent the past five years providing IBM, and a multitude of companies ranging greatly in size, with high quality, innovative technical Flere

£55 GBP / time
(348 bedømmelser)

Hello, You have just posted a project by requesting to write some articles. The reason you are here, I assume, is that you are looking for a writer, a writer who can deliver exactly what you want on time and without Flere

£13 GBP / time
(96 bedømmelser)

Hi there, I am an experienced freelance writer with a broad range of writing styles especially content, articles, blog posts, SEO articles, etc. With relevant experience in Education and English, I can take on any wr Flere

£30 GBP / time
(87 bedømmelser)

I'm a seasoned English writer with a strong background in professional writing. I have the ability to craft fresh and excellent pieces that interest and involve readers while maintaining a fluid voice as well as me Flere

£15 GBP / time
(128 bedømmelser)

I DO NOT OUTSOURCE I have been a freelancer for the past 8 years, I believe that my experience and skill in this background will prove to be of great help to you. Contact me to discuss more on the details

£13 GBP / time
(34 bedømmelser)

I have been writing professionally for the better part of a decade, taking the ideas, concepts and thoughts of my clients and turning them into compelling, engaging copy. I specialize in the ability to capture the uniq Flere

£15 GBP / time
(45 bedømmelser)

Hello, Marketing is a crucial part of any businesses' online strategy. It is not enough to simply to have an e-commerce offering or provide your contact details over the web. Instead, potential customers are hungry fo Flere

£20 GBP / time
(32 bedømmelser)

Looking for a pro technical writer with extra ordinary writing skills? well, i am a certified writer awarded many rewards by many MNCs i can serve high quality in your articles and can handle all your workload. Why Flere

£10 GBP / time
(13 bedømmelser)

Hey You are looking for someone to write technical contents and I’m well fit for this task. I have been working almost 3 years in the writing section. I can help you with this task. Please fell free to contact me so t Flere

£16 GBP / time
(21 bedømmelser)

Hi there, I’m quite interested in your job post for a copywriter to review and rewrite the knowledge materials, by putting the end-user at the core of the requirement, to deliver user-centric self-help documentation Flere

£13 GBP / time
(27 bedømmelser)

Hey, This is Ray from the United Kingdom. I have gone through your project description and I am very confident to take this up My content will be 100% unique and plagiarism free. It will be well-researched and up t Flere

£13 GBP / time
(1 bedømmelse)

Hey there. Hope you are doing well. Have you ever wanted a writer who could provide you with enticing and alluring content for all your content needs? Well, look no more. I have over 15 years of exciting and evol Flere

£27 GBP / time
(4 bedømmelser)

Hello .. I have the skills of translating French and English languages ​​into Arabic and vice versa ... I have writing skills and writing speed as a questionnaire and rewrite the books to pdf in French and Arabic .. Ex Flere

£10 GBP / time
(0 bedømmelser)

I have written copy for lawyers, scientists and IT engineers. I have worked in the automotive industry and have experience with transforming technical writing into easy to read comprehensive material. A lot of my prof Flere

£20 GBP / time
(0 bedømmelser)