Como estruturar conteúdo técnico para leitores não técnicos?

I consider it a fundamental step to know the audience because only then will we be able to identify who those people are and how to address them. In my case, every time we draft content with the team, we take into account the adaptation of tone and style, and of course, that we are addressing the inquiries or interests of those people. Only in this way will we achieve a perfect match.

To the tech-uninitiated, tech jargon is a parallel universe. If you’re from the tech world seeking my attention, step into my world. Tell me in the simplest way, what you’re driving at. Let’s say you’re explaining Facebook’s algorithm for top searches. Say it simply. ‘Judging from the number of people who are attracted to your product by searching for it through certain common keywords, Facebook places your ad at the top of the list of products in the same category.’ Ok. That makes sense to me. Proceed (in simple language) to interest me in your wares. Plain language is boring. Analogies are a great tool. Show, don’t tell, is a winner, too. Flowcharts, graphs, photos, videos… Quick recap, to make sure you’re still on the same planet.

User-centric language is the bridge between technical and non-technical realms. Framing complex terms in a way that aligns with the vocabulary of our audience fosters understanding and bridges the gap between domains. Another thing is that the multimodal content goes beyond text. Integrating multimedia elements like videos, podcasts, or interactive simulations caters to different learning preferences and enhances overall engagement. It's about providing a holistic and immersive learning experience.Practical relevance is the ultimate litmus test. Connecting theoretical concepts to real-world applications demonstrates the tangible benefits of the information. Thanks for reading out my opinion!

In my opinion, firstly we have to know the level of non technical writers and their mindset proportion. After that we have to manage ourselves in order to get their level and to write technical details as like they understand it in smooth way. In this way we have to make and use specified terms which they can understand easily. OR it might be like providing the technical details with daily based wording which everyone able to find it out. Many of things can be done of we do work in this regard.

Yes, #1 is correct and the most important thing. We as technical communicators must understand who our audiences/users are and why/what they are using the technology to do (their goals). Based on that understanding, we must name/label and organize/structure our content accordingly. This is "task-oriented" documentation, aka, "If you want to do Task A (the user would know what Task A is/want to do this), here are the steps to do that using our technology." NOT "Here is Feature X of our technology and here is what it does"; this MIGHT be useful "reference content," but it is NOT particularly helpful for end-users trying to perform a task. Good doc starts with user-centric labels in the UX.

Define your content's purpose practically: What specific actions do you want readers to take after engaging? Whether it's signing up, making a decision, or implementing a solution, be clear. Align content with what readers need to know for practical application. Your call to action should seamlessly guide them to the next steps. A practical content purpose ensures tangible outcomes, making the reader's journey purposeful and results-driven.

Most people are reading to become more knowledgeable. Therefore, put yourself in the readers' shoes and ask: “what's in it for me?" People should be better informed after reading your piece.

Je pense que la base c’est connaître l’objectif que l’on vise Ensuite identifier la cible, le segment ou la niche qui convient. Par la suite on peut réfléchir au message à transmettre. Le message doit être clair,court et précis

Defining purpose allows the audience to understand why they should care about what they are listening to. This is key to all audience members, and the those who are less technically invested will pay the more attention when this is being conveyed. Effectively summarizing the importance of the work being discussed helps ensure that all members of the audience will stay tuned for how the work may relate to them, how the concepts connect with their backgrounds, and how they can be connected or involved moving forward. If the audience only remembers parts of your talk, this is the part you do not want forgotten - this represents a key idea that hopefully will be communicated by listeners and acted on long after the initial presentation.

Reminds me of the saying, say what you are going to say, say it, and tell them what you said. Keep the reading at a grade level your audience can follow.

A former COO I worked under gave me some great advice. He said, "Write Dear mom and Dad" at the top of your paper and re-read it with them in mind. Think they could follow it? If not many of your readers may not be able to follow either.

When explaining a tech concept to a friend who's not into tech – skip the fancy words. Instead, use everyday language, like talking about everyday things. Break down complex ideas into simple bits, just like you would in a casual chat. Imagine you're having a coffee chat, not a lecture. This way, you make tech topics approachable, ensuring your friend, or your audience, gets what you're saying without getting lost in technical mumbo jumbo.

Without going too deep into the technicalities of content design, I’d like to establish that simplicity works a thousand times better in the particular scenario. It’s a layman trying to understand the content. Write and format like you’re talking to a 5-year old through it and half your job’s already done. And make sure to avoid jargon and technical terms. You want to make it easier for them to grasp the idea behind the content.

When crafting technical content for non-tech readers, simplicity is paramount. Ditch jargon and acronyms, or explain them in plain English. Opt for short, active sentences with everyday words. Tools like Hemingway or Readable can gauge readability and clarity. Make your content accessible—simple language ensures everyone, regardless of technical background, can easily understand and benefit from your message.

The German philosopher Arthur Schopenhauer was an advocate of simplicity. He wrote, "One should use common words to say uncommon things.”

Just think that you're pitching your content to a College student, "Here's the command, put it in and you'll get the correlation analysis of this data set." Clearly, the majority of our teachers wouldn't go through the heavy lifting of directly leading to a conclusion of various technical events. If you try to teach a person 'R' you can't simply get to the correlation analysis. You've got to start with the ultimate 'Mean, Median, and Mode', which is quite easy. You can try and structure your content in the most conscious way possible, in a concise language, and get where you want to ultimately.

All work - technical and non-technical - benefits from effective organization. Proper placement and ordering of information gives the framework that can be reliably followed, which fit into the spacing and timing of content. This means knowing where (and when) key concepts are introduced and when (and where) the takeaways will be summarized. Having a reliable structure shows respect for your own work and for your reader's time. Being able to consistently access the methods used or results obtained shows that the writer has taken the appropriate amount of pride in the work at hand and they want the reader to reach that information as easily as possible. For large documents, a well designed outline will allow efficient cross-referencing.

Um dos erros que mais vejo no conteúdo técnico é errar a hierarquia da informação. Isso é ainda mais grave nesse tipo de conteúdo, uma ve z que os assuntos tendem a ser muito complexos. Eu gosto sempre de exemplificar para o produtor de conteúdo que essa organização precisa acontecer da mesma maneira que explicamos o passo a passo de tarefas simples. Por exemplo: como fritar um ovo? 1. Abrir a geladeira 2. Colocar a frigeira no fogão? Não, primeiro, pegá-la no armário 3. Agora sim, colocar a frigideira no fogão 4. Colocar óleo Etc

Well organized content allows readers to find what they need quickly. Poorly organized content is frustrating. Keep in mind that the use of styles (headings, subheadings, etc) make the document accessible to visually impaired readers while also making things easy to find. When looking at order of content, consider several different reasons a reader may come to the document. Try to view the document from their perspective and make sure they will be able to find what they need. This can include a simple chronological order, table of contents, sections, headings, and search functions.

Structure is essential, but so is scannability. Let's be honest: Users don't have time to read your entire document. So, it's essential to keep things short and concise, and scannability should be prioritized. The idea is that readers should be able to find what they need as quickly as possible. Some tips for structuring technical content: - Keep headings and titles short and scannable - Make paragraphs concise and give plenty of room for scanning. Paragraphs shouldn't be longer than 5 lines. - Utilize numbered or bulleted lists to clarify content. - Break up longer or more complicated steps to make them as short and simple as possible.

By leveraging the power of visuals, communicators can bridge the gap between technical expertise and non-technical comprehension, ensuring that information is not only conveyed but also retained and applied effectively. The human brain processes visual information faster than text. Visual aids expedite comprehension, allowing non-technical readers to quickly grasp key concepts without feeling overwhelmed. They are excellent tools for showcasing comparisons between different elements or processes. Whether it's a side-by-side comparison or a before-and-after illustration, visuals simplify complex comparisons.

Our brain processes visuals thousands times faster than text! And also humans are visually oriented. So the information presented visually is often easier to remember. Moreover, it breaks down intricate technical details into more digestible components. They simplify the information, making it accessible to a broader audience with varying levels of technical knowledge.

Remember that not all people process information the same way. For some people words alone are enough. For others an image is the only thing they need. Visuals can provide reassurance that someone is on the right path. Use a combination of clear and specific visuals in key locations to ensure your readers don't get lost while working on something they are less comfortable with.

Visuals help people understand the technical processes or terminologies better. Also, they prove to be engaging, easy to consume, and creates a lasting impact on the reader's mind. Non-technical users always find it hectic to go through the large piece of content full of jargon. Instead they prefer to have something to visualise in order to comprehend things in an easy way.

Highly technical topics are more complex by default and adding visuals can bring in simplicity. For example, when writing about a technical process, you can visually describe it with infographics to supplement your content. This helps non-tech-savvy readers grasp the concept you are describing, making what you are trying to convey more digestible. To captivate and elucidate, leverage diverse visual aids like images, diagrams, and screenshots. Precision is key—ensure relevance, accuracy, and simplicity. Augment comprehension with captions and alt text, making your content universally accessible. A harmonious style and color scheme lend professionalism, while moderation prevents visual overload.

You always need a test reader, even if it's only you, 36 hours later. I know my problems when writing. I tend to use too many subordinate clauses for one thing. I can also be unnecessarily wordy. But I've found that trying to clean this up as I write breaks my own flow and the words don't come out as fast and clean as they might... so it's far better to just write the stuff that's there and not worry about ad hoc editing because it gums up the process. I can then come back to this later and do clean-up in an edit pass, resulting in firmer prose that was easier to write.

Any content must be thoroughly revised and tested to avoid publishing it with errors. Spelling and grammar issues with your content may invoke a low professionalism perception from your readers and you don't want that. To make sure your content demonstrates authority, always proofread to get rid of small issues that may be a drawback. Ask a colleague to proofread your draft and make sure there is a proper Technical correctness overview for technical content.

Tester et Réviser : Demandez à quelqu'un qui n'y connaît rien de lire votre contenu. Si cette personne comprend, c'est gagné. Sinon, retour à la case départ.

I love to write a draft with all of my ideas, then use that as a test for myself. Then once I've revised it I send it to someone who I can trust to edit for content. I love having at least two content editors and one really solid editor for the spelling and grammar. My grammar editors typical work with me via Zoom. I love these strategies to refine and produce the best written product.

En ocasiones encontramos textos con frases inconclusas , o incoherentes , y esto pude ser porque algunas veces cuando estamos redactando, cambiamos de idea pero no borramos bien todo lo anterior . Esto ensucia el texto y hace difícil su comprensión . Es uno de los motivos por los que es importantísimo revisar cualquier texto antes de publicarlo . Mostrárselo a varias personas es muy útil y si no es posible , dejar pasar un tiempo , o cambiar de actividad por un rato , para volver a leerlo después, nos da perspectiva a la hora de corregir un texto y detectar posibles errores .

This is my school of journalism and telling stories since 2000. Put it before them briefly so they will read it, clearly so they will appreciate it, picturesquely so they will remember it and, above all, accurately so they will be guided by its light. --Joseph Pulitzer

Use relatable, real-world examples to illustrate your points. Stories or analogies that non-technical readers can relate to can make the content more engaging and understandable. It is also a good idea to provide links to further reading or resources for readers who want to delve deeper into the topic. This allows non-technical readers to explore more if they are interested.

In my experience a brief and uncomplicated summary at the start of the article sets the tone for a good read. When it comes to technical writing it’s important to; explain unfamiliar jargon and abbreviations, use sub-headlines and bullet points, include real-world examples and comparisons, add helpful visuals and graphics, keep the article short and comprehensive. The Harvard Business Review is a great example of a publication that makes complex topics accessible to a wider audience through thoughtful writing.

Use interrogative sentences. They are a powerful tool for engaging readers and making them think. By asking the reader questions, the author engages the reader in a conversation. This creates a connection and makes reading more participatory and interesting.

La "traducción" de contenidos técnicos hacia audiencias mainstream no es hablar con palabras simples. Aquí les comparto 3 consejos: 1. Lee mucho sobre el tema que estás trabajando. Asesórate con expertos y pide la ayuda que requieras para poder entender el tema en profundidad. 2. Revisa cuáles son tus audiencias clave. De eso dependerá el formato y canal donde se colocará el contenido. 3. Haz un doble check con tu contenido listo. Pide feedback y revisa si realmente se están cumpliendo los objetivos planteados.