Technical writing: Introduction

(This comes from a manual I’m writing for my technical writing class.)

Welcome to Scientific Writing, MBB 100.

You are here because you want to improve your ability to write. Scientific writing is, indeed, a critical skill for researchers and professionals in various fields, allowing them to effectively communicate complex information to diverse audiences. In this course, we will cover the principles of scientific writing, including audience analysis, organization, clarity, conciseness, and style, as well as practical techniques for drafting, revising, and editing scientific documents, such as research papers, technical reports, and grant proposals, to effectively convey scientific information to readers.

Why do we need to communicate well?

It’s our professional mandate. It’s a role we scientists have been carrying out dating back to the earliest scientific publications which allowed researchers to disseminate their findings, ideas, and discoveries to a global audience in a clear, concise, and credible manner, while also fostering the development of new knowledge and advancing scientific inquiry. We share our work so that others can build on them, that’s how scientific knowledge and understanding advances. We also write to receive feedback on our work and establish our expertise in a particular field. We write to secure funding or other support for further research.

We write in order to advance in our careers. Our production in terms of papers in scientific journals and grant proposals are measures of productivity, impact, and contributions to our field. Personal letters and notes are not often published or evaluated, but they are part of the exchanges that lead to publications.

What will we learn in this course?

We will learn a number of standards and techniques. The standards of scientific writing facilitate understanding within the community. These standards include:

  1. Audience: Consider who your audience is and tailor your writing to their level of expertise and understanding.
  2. Clarity: Use clear, concise language and avoid jargon or overly technical terms that may be confusing to readers.
  3. Structure: Organize your paper in a logical and coherent manner with a clear introduction, body, and conclusion.
  4. Citations: Make sure to properly cite all sources used in your paper and follow the appropriate citation style guidelines.
  5. Accuracy: Ensure that your paper is factually accurate and supported by evidence from reliable sources.
  6. Formatting: Follow any specific formatting guidelines provided by the journal or publication you are submitting your paper to.
  7. Revision: Edit and revise your paper to ensure it is free of errors and effectively communicates your research findings and ideas.

These standards also comprise techniques that ensure those standards are met. For instance, logical techniques for structuring an argument in a biology paper include deduction, inference, and story-telling. Furthermore, some logical standards have a long tradition, such as the IMRaD format, while stylistic standards in the area of language and style continue to evolve, such as the use of the active voice of verbs.

Of the techniques, I would like to emphasize Revision. I would like to do this to calm a common fear, especially with young writers: the fear that you won’t write well enough.

Let’s settle that right now: I don’t want you to write well. I want you to edit well. I do not expect pretty first drafts, not even perfect fifth drafts. I would like to make it clear that the art of writing is editing.

Let’s take a look at editing first; we will do some writing later. As we look into editing, let me address the elephant in the room, namely, ChatGPT. Good or bad? It’s a tool. The first time I tried it, ChatGPT gave me a short essay in less than 30 sec which I found lame; I edited it over the next 20 minutes.

Let’s do that now. I gave ChatGPT this promt: “Write an essay about the art of writing.” This is what it gave me:

Writing is a form of artistic expression that has the power to captivate, inspire, and enlighten its readers. Whether it takes the form of literature, journalism, or even business communication, the art of writing is essential to the way we communicate with each other.

At its core, the art of writing is about finding a voice and using it to convey meaning. This means being able to communicate complex ideas in a clear and concise way, while also imbuing one’s writing with personality and style. It requires both creativity and discipline, as well as an ability to balance structure and spontaneity.

One of the key elements of effective writing is a deep understanding of the audience. Writers must be able to anticipate the needs, interests, and perspectives of their readers in order to create content that resonates. This requires research, empathy, and an ability to connect with people on a fundamental level.

Another important aspect of the art of writing is the ability to edit and revise. Good writing is rarely the result of a first draft; instead, it often requires multiple rounds of revisions and refinements. This involves not just correcting grammar and spelling, but also refining the tone, structure, and flow of the piece.

The art of writing is also closely tied to the art of storytelling. Whether it takes the form of a novel, a memoir, or a news article, effective writing often relies on the power of narrative to engage and captivate readers. This means creating characters, setting a scene, and building tension and suspense, all while remaining true to the underlying message or theme.

Finally, the art of writing is a craft that requires constant practice and refinement. It is not something that can be mastered overnight, but rather something that requires a lifelong commitment to learning and growth. Whether through taking writing classes, attending workshops, or simply continuing to write on a regular basis, the best writers are always striving to improve their skills and expand their horizons.


In conclusion, the art of writing is a powerful form of artistic expression that has the ability to change minds, provoke thought, and inspire action. Whether through novels, journalism, or other forms of communication, writers have the ability to use words to shape the world around them. By honing their craft, understanding their audience, and telling compelling stories, they can become true masters of the art of writing.

Not bad; but it’s not me. It’s important for your writing to “be you”; I’ll tell you more about that after we edit this.

Here are my comments, underlined inside [braces]. The edited version is in boldface. Do not consider these the best suggestions:

One of the [key elements, generic word, element ] of effective writing is a deep understanding of the audience. Writers must be able to anticipate the needs, interests, and perspectives of their readers [in order, not necessary] to create content that resonates. This requires research, empathy, and an ability to [connect with people on a fundamental level., fundamental is too long]


A good writer must know his or her audience. The writer must be able to anticipate the needs, interests, and perspectives of his or her reader to create content that resonates. This requires research, empathy and an ability to connect with people on a deep level.


Another important aspect of the art of writing is the [ability to edit and revise., ability to is too long] Good writing is [rarely, really?] the result of a first draft; [instead, it often requires multiple rounds of revisions and refinements., too long] This involves not just correcting grammar and spelling, but also refining the tone, structure, and flow of the piece.


The true art of writing is editing. Good writing is never the result of a first draft. It comes from rounds of revision and refinement made on points of grammar, spelling, tone, structure, and flow of the piece.


The art of writing is also [closely, adverbs are often excessive] tied to the art of storytelling. [Whether it takes the form of a novel, a memoir, or a news article, jumping then returning], effective writing often relies on the power of narrative to engage and captivate readers. [This means, not necessary] creating characters, setting a scene, and building tension and suspense, all while remaining true to the underlying message or theme.

Good writers also know how to tell a story. Stories engage and captivate readers, whether they take the form of a novel, a memoir, or a news article.

Finally, the art of writing [is a craft, too long] that requires constant practice and refinement. It is not [something, generic] that can be mastered overnight, but rather [something, generic] that requires a lifelong commitment to learning and growth. [Whether through taking writing classes, attending workshops, or simply continuing to write on a regular basis, jumping then returning] the best writers are always striving to improve their skills and expand their horizons.

Finally, the craft of writing requires constant practice. It requires a lifelong commitment to learning and growth, and it cannot be mastered overnight. The best writers are always striving to improve their skills, whether through taking classes, attending workshops, or simply writing on a regular basis.

In conclusion, [the art of, not necessary] writing is a powerful form of artistic expression that [has the ability, can] to change minds, provoke thought, and inspire action. [Whether through novels, journalism, or other forms of communication, repetition], writers have the ability to use words to shape the world around them. By honing their craft, understanding their audience, and telling compelling stories, they can become true masters of the art of writing.

In conclusion, writing is a powerful form of expression that can change minds, provoke thought, and inspire action. Writers shape the world around them. One can become a true master of the art by honing one’s craft, especially the skill of telling stories.

YOUR writing is evidence YOU passed through this earth. You can’t really hide your originality. Your writing has “signatures” such that we can say “here, he makes an insight”, “here, he faced a dilemma”. These little things make writing human. A technique that helps you to write in your personal style is to write in the first person. I recommend you do this for all your drafts; just edit later according to prescribed standards.

So for the exercise. Answers the question: If I could spend my WHOLE LIFE answering just ONE question, what would that question be? Why is that question so important to me? Write a paragraph in the first person.

Let me leave you with advice: write at every chance.

I carry a notebook. Whenever I have a bit of time, like waiting for Grab, I write. No concern with grammar or style or completeness. What do I write about? I have a pipeline of topics, and it keeps growing. I type up some of my essays in files designed for publication as a book or blog, and of course, research articles.

To motivate myself, I try to make writing a sensory experience. I like the feel of a fountain pen on paper (I use a LAMY with a special flat tip) and thick paper. I think a mechanical keyboard is pretty cool, with customizable lights and sounds. A friend of mine who is now writing her 14th published book, does all her writing on her iPhone, in cafes, museums, or any public space.

Writing helps you think better by slowing down your emotions, giving you space for careful thought. If you feel like sending a nastygram, and you want to do it by email, type it out, but wait at least half an hour before pressing SEND. Better yet, rant in longhand. Then burn it.

In the next meeting, we will talk about the Letter to the Editor. I will talk to you about the technique of writing Lead Sheet. I’ll also introduce you to another software I use, JDarkroom.

(Q.C., 230214)

Leave a comment