How to write specialized texts and not overwhelm your audience

typewriter-801921_1920.jpg

(Catalan below)

Tricks on technical writing for non specialized audience

“If you cannot explain it simply, you don’t understand it well enough” Albert Einstein

Have you ever felt overwhelmed trying to understand specialized documents? For sure, we all have sometime! And we remember a number of these paperworks or we even have written some. Obscure writing? No way! When our target is non specialized audience we need to avoid dreadful technical writing and make it simple.

The idea that professionals (economists, chemists, doctors, biologists, officers, bankers, nurses, entrepreneurs, CEO…) don’t need to know how to write properly is false. We live in a communicating world: sooner or later these professionals will be asked to write professional paperworks, projects, memorandums, speeches, reports, articles… The maxim make it simple is the core idea, the broad writing philosophy, but how do we get there? Following are some tricks on writing killer outreach texts.

Before writing:

  • Target: take into account your target, the audience you are writing for.
  • Aim: get a clear idea of what your goal is!
  • Information: identify main ideas and priority messages you want to communicate.
  • Ideas: arrange the general ideas from most to less important ones.
  • Formality: choose the level of formality or tone which will attract the attention of your audience and help you achieve your goal.

Writing:

  • Text: structure your text in paragraphs (short introduction, development and short conclusion).
  • Paragraph: arrange the ideas in the paragraph from most to less important ones.
  • Sentences: write short sentences; avoid too long or subordinate sentences as much as possible.
  • Words: use plain words and avoid jargon, though, and only when unavoidable, you might need to use some technical terms.
  • Clarity: use easy and understandable expressions to grant comprehension.
  • Concision: avoid unnecessary information; remember that less is more!
  • Precision: be precise, avoid ambiguities or misunderstandings.

After writing:

  • Revision: put your copy aside for at least 24 hours, afterwards review it in a critical sense, make it sure you applied the tips above, question yourself if it’s clear enough and try to improve it.

Finally, remember: successful delivery in communications nowadays is essential. Communication is a crucial point for companies or individual professionals because what distinguish themselves is the image they project outside to society rather than the products or services they offer. This is the key for making yourself understood. So, when writing plans, projects, executive summaries and so on, remember: make it simple and clear!

More information:

Alley, Michael. The Craft of Scientific Writing

Universitat de Barcelona, Universitat Autònoma de Barcelona, Universitat Politècnica de Catalunya, Universitat Pompeu Fabra, Universitat de Girona, Universitat de Lleida, Universitat Rovira i Virgili, Universitat Oberta de Catalunya, Universitat de Vic. Argumenta, Producciuó de textos

Cassany, Daniel. Esmolar l’eina. Guia de redacció per a professionals

Kelley, Nocole. Sentence Structure of Technical Writing. Program in Writing and Humanistic Studies. MIT

Servei de Llengües Modernes de la Universitat de Girona. UdG Llengua. Guia lingüística i d’estil


typewriter-801921_1920Com escriure textos d’especialitat i no aclaparar els teus lectors

Trucs per escriure textos d’especialitat adreçats a no especialistes

“Si no ho pots explicar de manera senzilla, no ho entens prou bé”
Albert Einstein

T’has sentit mai desbordat intentant entendre documents especialitzats? De ben segur que tots ens hi hem sentit algun cop! I que recordem uns quants d’aquests maleïts escrits o fins i tot n’hem escrit algun. Escriure crípticament? Ni pensaments! Si el nostre objectiu és públic no especialitzat cal que evitem els esfereïdors textos enrevessats. Fem-ho fàcil!

La idea que els professionals (economistes, químics, metges, biòlegs, administratius, banquers, infermeres, emprenedors, directius…) no necessiten conèixer tècniques d’escriptura és falsa. Vivim en la societat de la comunicació, per tant, tard o d’hora aquests professionals han d’escriure projectes, presentacions, informes, articles… La màxima fem-ho fàcil és la idea bàsica, la filosofia general per escriure, però com es fa? Aquí hi ha alguns trucs per escriure textos de divulgació que facin furor.

Abans d’escriure:

  • Públic: tingues en compte a qui t’adreces, per a quin públic escrius.
  • Propòsit: fes-te una idea clara de quin és el teu objectiu!
  • Informació: identifica les idees i els missatges principals que vols comunicar.
  • Idees: ordena les idees generals de més a menys importants.
  • Formalitat: tria el nivell de formalitat o el to que atraurà més l’atenció del teu públic i t’ajudarà a aconseguir el teu objectiu.

Mentre escrius:

  • Text: estructura el text en paràgrafs (introducció curta, desenvolupament i conclusió curta).
  • Paràgraf: ordena les idees del paràgraf de més a menys importants.
  • Frases: fes frases curtes; evita les frases excessivament llargues o les subordinades tant com sigui possible.
  • Paraules: usa paraules planeres i evita l’argot, encara que, només si és inevitable, pots fer servir algun terme d’especialitat.
  • Claredat: usa expressions fàcils i entenedores per garantir que et comprenen.
  • Concisió: evita informació supèrflua; recorda el less is more i evita tot allò que no aporta res!
  • Precisió: sigues precís, evita ambigüitats o confusions.

Després d’escriure:

  •  Revisió: deixa de banda l’escrit durant almenys 24 hores; després revisa’l amb una mirada crítica; assegura’t que has aplicat els punts anteriors; qüestiona’t si és prou clar, i intenta millorar-lo.

Finalment, recorda que una bona divulgació avui és essencial. La comunicació és un punt crucial per a les organitzacions i els professionals ja que el que els distingeix de la resta és la imatge que projecten enfora, més que els productes o serveis que ofereixen. Aquest és el punt clau pel qual t’has de fer entendre fàcilment. Per tant, quan redactis plans, projectes, resums executius, etc. recorda: fes-ho simple i clar!

Més informació:

Alley, Michael. The Craft of Scientific Writing

Universitat de Barcelona, Universitat Autònoma de Barcelona, Universitat Politècnica de Catalunya, Universitat Pompeu Fabra, Universitat de Girona, Universitat de Lleida, Universitat Rovira i Virgili, Universitat Oberta de Catalunya, Universitat de Vic. Argumenta, Producciuó de textos

Cassany, Daniel. Esmolar l’eina. Guia de redacció per a professionals

Kelley, Nocole. Sentence Structure of Technical Writing. Program in Writing and Humanistic Studies. MIT

Servei de Llengües Modernes de la Universitat de Girona. UdG Llengua. Guia lingüística i d’estil

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s