Category Archives: Writing research reports

Co-authors should define their roles and responsibilities before they start writing

Have you ever had problems when co-authoring a document?

Are you about to co-author a document but have not had a lot of experience of working with other authors? Have you worked with other authors who avoid replying to your emails, contribute little to the document, then expect to be included as an author? Have you sat down with your co-authors and decided who will do what task, then find that one author has taken charge of the writing project? Have you had disputes about who should be the lead author of your paper? These problems reflect a lack of planning: co-authors should define their roles and responsibilities before they start writing.

Being an author of a published scientific document brings responsibilities: you are acknowledged as having written and designed that document and you may need to verify or defend your writing.

If you are the author of a document presenting original research you are presenting yourself as the person responsible for designing and completing the study and you will be given credit for any original ideas, new findings and conclusions. You are responsible for verifying the integrity of your work. If there is more than one author, the credit and responsibility is assigned equally to all authors, even with the understanding that the first author is often the major contributor.

When co-authoring a document, each author will complete different tasks. The amount and type of work completed by each author will vary according to the nature of the project, the topic, the industry’s or discipline’s conventions and the number of co-authors.

Should each author's contribution be listed in the document?

Whether or not the contributions of all co-authors are included in the document itself, will depend upon the type and purpose of the document. For example, with a short, three-page report prepared by a company for a client, it might not be appropriate to state who the authors are, let alone outlining what their contributions were. In some instances, outlining co-authors contributions is essential. When submitting an article for a peer-reviewed journal, it is usually a requirement that co-authors meticulously outline their contribution to the document. For example, the ICMJE (International Committee of Medical Journal Editors) state “In addition to being accountable for the parts of the work he or she has done, an author should be able to identify which co-authors are responsible for specific other parts of the work. In addition, authors should have confidence in the integrity of the contributions of their co-authors.”


Co-authoring is often unplanned

In many instances, the contributions of co-authors are not documented or even formally agreed to; a group of co-authors might discuss allocation of tasks over a coffee in an informal meeting or through short emails. In many instances, there is no prior agreement between co-authors at all which can lead to significant problems.

If the role and responsibilities of co-authors are not managed effectively, the process of writing can take longer than it should, or worse, documents may be poorly written or never get completed. Confusion about who does what can cause disagreement between authors and dramatically reduce the quality and quantity of what is written. Additional problems include:

- disputes over who is in charge of the writing project, who has the final say about the content or conclusions or who is the lead author

- unrealistic expectations by a writer being nominated as author when they have made an insignificant contribution

- objections by a colleague being nominated as an author when they consider their contribution to be minimal, preferring instead to be mentioned in the acknowledgements.

- unnecessary duplication of writing, editing and analysis tasks

- insufficient completion of essential tasks that is either not recognised at all or completed at the last minute without sufficient quality control

- ad-hoc invitations for other writers to contribute at different stages

Irrespective of the type of document produced, each co-author should outline their proposed contribution in separate document before they start writing. This is necessary for a well-managed project, as the role of authors can often change during the process of drafting of a document and written agreements are easier to manage than verbal agreements. An authorship agreement document can be updated if there are any changes and modified for different project. An example is the Authorship Agreement template from Southern Cross University. 

Steps in developing a Co-author Agreement:

1. Refer to a published authorship policy for guidance

An authorship policy outlines what contributions are necessary for someone to be considered an author of a document. Most universities have authorship policies (e.g. Adelaide University), as do publishing companies, editorial committees and research institutions. The Australian Code for the Responsible Conduct of Research (2007) section on Authorship (5.1) states: …“To be named as an author, a researcher must have made a substantial scholarly contribution to the work and be able to take responsibility for at least that part of the work they contributed. Attribution of authorship depends to some extent on the discipline, but in all cases, authorship must be based on substantial contributions in a combination of:

  • conception and design of the project
  • analysis and interpretation of research data
  • drafting significant parts of the work or critically revising it so as to contribute to the
  • interpretation.”

2. Identify what contributions are necessary before assigning tasks to authors

If there is no lead author who is in charge of the writing project, as a group, co-authors should decide what contributions are necessary before assigning, or agreeing to tasks. This will ensure essential tasks are not overlooked and may prevent additional, unnecessary tasks (i.e. the preparation of 12 images for publication when one will suffice).

3. Draft an Co-author Agreement document

Draft an Co-author Agreement document that outlines each author's role, responsibilities and contributions to the document. This can also include timelines for completion. Send the draft to all co-authors for comment and feedback.

4. Finalise Co-author Agreement document

Once all authors have agreed to the outline, finalise the agreement and return to all authors. Once the contributions of each co-author are assigned and agreed to, then the writing can commence. If co-authors maintain regular communication while preparing the document, any changes to contributions can be further monitored.

The final Co-author Agreement document can also be developed as a template for future projects

© Dr Marina Hurley 2022 www.writingclearscience.com.au

Any suggestions or comments please email admin@writingclearscience.com.au 

Find out more about our new online course...


SUBSCRIBE to the Writing Clear Science Newsletter

to keep informed about our latest blogs, webinars and writing courses.

Bullet point lists versus paragraphs

This writing guide follows on from my previous writing guide, How to Structure Bullet Point Lists and focuses on when to use bullet points and when to use paragraphs. Although the difference between the two is obvious, some writers create unwieldy bullet points (see Figure 1) that would serve better as a paragraph or write dense paragraphs that could serve the reader better if presented as bullet point lists.

Before a comparison between the two can be made, the information must be in a form of a list or be easily converted into a list, and this is usually possible if a paragraph has the structure of a statement, followed by examples.

The following example could be written as either a paragraph or a bullet-point list.

“Technical communicators can create technical information for new products or update existing information. They might research or test a product to interpret and test technical information or specifications. Some tasks include working with or interviewing subject matter experts (SMEs) to extract information and uncover the missing details that a user might need to know.”  (From https://www.astc.org.au/about-technical-communications)

In this example, the introductory element is: “Technical communicators can create technical information for new products or update existing information.” Everything else in the paragraph are examples of these tasks.

With minimal changes, this could be rewritten into a bullet-point list as follows:

Technical communicators can create technical information for new products or update existing information. Some tasks may include:

  • research or test a product to interpret 
  • test technical information or specifications
  • work with or interview subject matter experts (SMEs) to extract information and uncover the missing details that a user might need to know.

Figure 1: This is an example of a complicated bullet point list: some list items are very long

Some factors to consider when choosing to write paragraphs or bullet point lists

1. The length of your sentences 

If your sentences are:

-  long, bullet points might be easier to read.

-  short and there are a few of them, paragraphs may be just as easy to read as a bullet point list.

2. The number of list items

- If you have more than three list items within a sentence, consider turning them into bullet point lists.

- If you have many list items (i.e. more than 8-10), they may be difficult to read as either bullet point lists or paragraphs. If you do have very lengthy lists, consider using a table instead.

3. The number of bullet point lists in your document

The number and placement of bullet point lists affects the layout and presentation of your document. Too many successive bullet point lists may be difficult to read. If most of your document does consist of bullet point lists, try turning some into paragraphs to help break up the text. Be mindful that if you write bullet point lists within bullet point lists (also known as multilevel lists) make sure they are not difficult to read.

4. The size and number of your paragraphs

If you have many large paragraphs within a document, turning some into bullet point lists will help break up the text. Also consider breaking up large paragraphs into smaller paragraphs.

If you have many small paragraphs, then bullet point lists may not be necessary. Sometimes I find that if a document has lots of small (single sentence) paragraphs, then it ends up looking like a continuous bullet point list anyway.

Finally, don’t forget that the layout of your document influences its’ readability. So consider:

- What is the best way to effectively arrange your paragraphs and bullet point lists within your document?

- What is the best way to incorporate paragraphs and bullet point lists with other important features such as figures, tables, images and headings.

© Dr Marina Hurley 2021 www.writingclearscience.com.au

Any suggestions or comments please email admin@writingclearscience.com.au 

Find out more about our online science writing course...


SUBSCRIBE to the Writing Clear Science Newsletter

to keep informed about our latest blogs, webinars and writing courses.

How to structure bullet point lists

What are bullet point lists?

When lists are presented with one list item per line, following an indented marker or symbol. they are commonly referred to as ‘bullet points’ or ‘bulleted lists’. Bullet point lists are widely used in science report writing but are rarely used in peer-reviewed journal articles (primarily due to save space).

What is the purpose of bullet points lists?

Bullet point lists are generally used for unnumbered and unordered lists and allow information to stand out separately from paragraphs and other surrounding text. Well-designed bullet points help attract the reader's attention when skimming a document and help them to quickly absorb multiple subtopics.

Making sure that bullet points are structured correctly also helps writers to clarify their thinking. Bullet point lists avoid the need to force a sentence or paragraph to contain lengthy and unwieldy lists. They allow the writer to be more succinct as the repetition needed to link connected sentences within a paragraph can be removed. They can also help to reduce the word count if the list is composed of simple phrases or sentence fragments rather than complete sentences.

The problems with the use of bullet point lists

Many writers are unsure how to structure bullet point lists and use them incorrectly. Some writers use paragraphs when they could have used bullet points and some overuse bullet points instead of writing paragraphs. Some writers haphazardly throw all types of information into bullet points, making them difficult to read. Therefore, guidelines are necessary.

When and how should bullet point lists be used?

There are different ways to structure bullet points. However, ensuring consistency and clarity of meaning is crucial. Two common questions I’m asked are, “Should bullet points be capitalised?’ and “Should bullet points be followed with commas or semi-colons?” My answer to both is, that it depends on what you are writing and how your structure your introductory elements and list items. An introductory element is the use of a phrase, sentence fragment or complete sentence to introduce the bullet point list.

1. Bullet point lists are introduced with a phrase, a sentence fragment or a complete sentence (introductory element). 

The introductory element is usually followed by a colon (See Example 1).

Example 1

The following is a brief overview of:

- my understanding about the broad types of software tools on offer.

- how different pricing models influence my choice of tools.

- the current software tools I regularly use for writing, teaching and managing my training consultancy.

- what to keep in mind when searching for good software tools.

(from ‘FAQ: What software tools do I use for writing and teaching?’)

2. Each list member must logically complete the meaning conveyed in the introductory element.

As Example 1 is introduced with a sentence fragment (‘The following is a brief overview of:’) each list item must form a grammatically-correct complete sentence when combined with it. For example, the second list item would be read as: “The following is a brief overview of how different pricing models influence my choice of tools.” This is why the first word of each list item is not capitalised and why full stops are used at the end of each list item.

It is very common for writers to avoid this important guideline and not check to see if each list item logically follows on from the introductory element. An incorrect way to represent the information in Example 1 would be as follows:

Hypothetical (incorrect) Example 2

The following is a brief overview of:

- my understanding about the broad types of software tools on offer.

- how different pricing models influence my choice of tools.

- Includes a current list of software tools I regularly use for writing, teaching and managing my training consultancy.

- Also some tips to keep in mind when searching for the good software tools.

The last two list items, although still relating to the topic, do not follow on from the introductory element. For example, the 3rd list item would read, “The following is a brief overview of Include a current list of software tools I regularly use for writing, teaching and managing my training consultancy.” This does not make sense.

3. If an introductory element stands alone as a heading, it doesn’t need any punctuation (see Example 3 below). 

Nevertheless, in this example you could still place a colon after the introductory element.

Example 3

Remember

- Plans are not meant to be perfect but act as a guide to your thinking and a framework to further develop the project you are working on.

- Keep all versions of your plans for future reference or to use as templates for future projects.

- Ask colleagues for feedback on your plans as well as your document drafts.

 (from ‘The essentials of science writing: plan before you write’ )

4. If the bullet points are composed of complete sentences, they should be each be treated as a normal sentence with capitalisation and terminal punctuation (e.g. full stop, question mark) (see Example 3 above).

5. Consistency is crucial:

- Use the same symbol or marker for your bullet points throughout your document.

- Although you may have different types (structures) of bullet point lists within the same document, all list items within a bullet point list should be the same format: all phrases, all sentence fragments or all complete sentences.

This is another reason why Example 3 is incorrect as the 3rd point is a complete sentence, while the 4th point is a sentence fragment and both are dissimilar in structure to the first two points.

6. Bullet point lists items that are phrases or sentence fragments need no punctuation (see Example 4 below).

 

Example 4

Common writing problems often reflect that a writer has not thoroughly considered who their audience is, or what they need. This can cause the following problems:

- providing too much (or not enough) detail or background information

- providing too much detail on unrelated sub-topics or on a well-known topic

- using the wrong language or unfamiliar terminology

- assuming the audience’s level of interest in, or understanding of, the topic

(from How to identify your target audience,)


7. Ensure that your list items are distinct from each other (compare examples 5 & 6).

Example 5

An example of distinct list items:

I agreed to the following decisions:

- the start date of the project.

- that the consultation committee have a maximum of five registered members.

- the due date of the first stage of the report.


Example 6

An example of indistinct list items:

The following is a brief overview of:

- my understanding about the broad types of software tools on offer.

- how different pricing models influence my choice of tools.

- how different pricing models influence the way I research software tools.

In this example, the 3rd list item is closely related to the 2nd list item, so I would either combine them all leave point 3 out.

8. The list items can be presented in any order. If they must be presented in a certain order, they should be numbered and considered a ‘numbered list’ and not a bullet point list (See example 7).


Example 7 

Example of a numbered list

Steps to complete your enrolment:

  1. Read the terms and conditions.
  2. Download and complete the application form
  3. Email the application form to emailus@address.com
  4. Follow instructions in enrolment notification email.

9. Use commas or semi-colons at the end of each list item if you are presenting a list as though it was part of an entire sentence (see Examples 8 and 9). 

Hypothetical Example 8 (with commas)

The site contained the following species:

- Eucalyptus saligna,

- Eucalyptus siderophloia,

- Eucalyptus oreades and

- Eucalyptus regens.

As a complete sentence this would be written as “The site contained the following species: Eucalyptus saligna, Eucalyptus siderophloia, Eucalyptus oreades and Eucalyptus regens.”

This type of bullet point list could also make a complicated list easier to read than if it was written in a sentence (see Example 8).

Hypothetical Example 9 (with semi-colons)

The site contained the following species:

- Acacia daviesioides (over 3 dozen seedlings);

- Acacia glaucoptera (3 shrubs);

- Acacia incurve (over 1000 small to medium shrubs);

- Eucalyptus saligna (over 200 seedlings);

- Eucalyptus siderophloia (one large tree and 3 saplings);

- Eucalyptus oreades (six saplings) and

- Eucalyptus regens (over 300 trees).

As a complete sentence this example would be written as “The site contained the following species: Acacia daviesioides (over 3 dozen seedlings); Acacia glaucoptera (3 shrubs); Acacia incurve (over 1000 small to medium shrubs); Eucalyptus saligna (over 200 seedlings); Eucalyptus siderophloia (one large tree and 3 saplings); Eucalyptus oreades (six saplings) and Eucalyptus regens (over 300 trees).

If you find you are writing these types of sentences or bullet point lists, depending on the type of document you are writing, it might be better to use tables instead.

© Dr Marina Hurley 2021 www.writingclearscience.com.au

Any suggestions or comments please email admin@writingclearscience.com.au 

Find out more about our online science writing course...


SUBSCRIBE to the Writing Clear Science Newsletter

to keep informed about our latest blogs, webinars and writing courses.

What is the difference between a good idea and a theory?

Some terms used to discuss and describe science are often used interchangeably which can cause confusion: for example, terms such as fact, hypothesis, theory, knowledge, information, results and findings. In this writing guide, I define some commonly-used terms used to describe science, while also explaining how science information is produced. 

I need to first acknowledge that numerous philosophers and have spent many years, even entire lifetimes, debating and discussing the precise meaning of some of these terms. So I encourage you to read some of the books by important science authors and philosophers including Thomas Kuhn, Karl Popper, Stephen Jay Gould and Stephen Hawking to develop a solid understanding of science philosophy and the current developments in science. Bill Bryson’s Short History of Nearly Everything is also an excellent coverage of science suitable for a wide audience.

Knowledge versus information

The term knowledge is often used instead of information. However, science knowledge is what people gain or learn through absorbing science information or through doing their own research. Science information is a collection of facts that is based upon evidence which is the result of peer-reviewed or peer-verified research.

The degree to which science information is considered true and correct will vary according to when the research was published, how large or lengthy the study was and the amount of published evidence that supports this information. Undoubtedly, there is a lot of information that may be considered true but is yet to be scientifically tested; for example, some home remedies for illnesses.


Facts, assumptions and opinions

A scientific statement of fact is an explanation of a phenomenon or something that is generally held to be true and can be proved by evidence. Facts can later be disproved, as can hypotheses and theories. Communicating information as a judgement or a statement of fact, but without providing proof that it is true, is expressing an assumption, while believing that something is true based upon little or incomplete evidence is forming an opinion.

Scientific opinions are generated from science knowledge, and may or may not be true, but they are important for developing new ideas, new hypotheses and new science. Scientific opinions and ideas need to be developed into hypotheses or problems that can be tested and supported (or rejected) by research.

What should be cited

Strictly speaking, all science information that is not common knowledge should be cited; that is, the source of the information should be presented so that the reader can verify that the information is supported by evidence. Where relevant, opinions should also be acknowledged, otherwise, it may be difficult for a reader to understand the difference between a scientific opinion and an uncited statement of fact (common knowledge).

Common knowledge is what would be generally be accepted as being true without question by a large proportion of a group of people familiar with a certain topic. What is accepted as common knowledge of a topic will depend upon the background, knowledge and experience of the reader.

Results versus findings

The science information produced by a study and published in a research paper is also known as the study’s findings. Collectively, both the Results and the Discussion parts of a research paper represent the authors findings. The Results present the data or observations of the study and the Discussion presents the author’s interpretations that explain what these results mean in relation to the scientific problem under investigation.

Traditionally, the format of the research paper is to distinctly separate the Results and Discussion sections so that the bare measurements of the results are not mixed in with, and made indistinguishable from, the author’s discussion or interpretations of their results. As different people may interpret the same data differently, it was (and still is) considered important to allow the reader to clearly see the results in isolation.  However, it may be difficult to separate results and discussion with some types of projects and within some disciplines.

Scientific interpretations are based upon the author’s knowledge, which is gained through their experience, through their reading and through their analytical (inductive and deductive) skills. If these scientific interpretations are accepted by peer-review and published, they may then be considered scientific facts. If other authors disagree with the interpretations in a published paper, they are expected to publish their own papers accordingly and a scientific debate may ensue. Individual interpretations will develop into a scientific consensus when similar studies produce similar results and different authors develop similar conclusions.

Similarly, a theory is supported by consensus. A theory describes the behaviour or activity of a phenomenon or phenomena. It is a statement supported by accepted hypotheses and empirical evidence. A hypothesis is a statement that describes the properties or behaviour of an object or phenomena. A hypothesis is either supported or rejected based upon the evidence developed from testing the hypothesis. A specific, simple hypothesis or null hypothesis is one designed to be easily tested; it can be either accepted or rejected or upheld or discarded. If repeated tests under different circumstances support the hypothesis, then the hypothesis can be developed into a theory. From this theory further hypotheses can be generated. A theory can be supported, validated, reframed, modified or rejected according to evidence. A theory that has been refuted must be discarded and is no longer referred to as a theory.

© Dr Marina Hurley 2026 www.writingclearscience.com.au

Find out more about our online courses...


SUBSCRIBE to the Writing Clear Science Newsletter

to keep informed about our latest blogs and writing workshops.

How to identify your target audience


When we write, we write about something (the topic) in a certain format (the document type) for a reader or group of readers (the audience). Deciding what we are writing about and what type of document to prepare is usually straightforward for most writers. However, deciding who we are writing for is not always thoroughly considered. To a large degree, the audience of a document is determined by the type of document and the subject matter but unless researchers and other science writers have a background in marketing, the concept of identifying and catering to a target audience might not be a high priority.

DOWNLOAD THE INFOGRAPHIC '6 ways to identify and cater to your target audience'

What is your focus?

A document is not simply a receptacle for words, it is a tool of communication that should perform a service for readers. Thinking about who will read our document or what they might want from our document, is something that writers might avoid if they are author-focused or project-focused. Author-focused writers have discoveries, data, knowledge and information that they need to share and primarily concentrate on getting their document published. Project-focused writers key motivation is to satisfy project, organisation, company or client objectives. Audience-focused writers design their document according to the needs of the target audience, while still satisfying their own needs as an author and addressing project and client objectives.
Decide exactly what you want to do for your audience

Unless catering to a target audience is a central objective, your document may lack some of the fundamentals of good document design. Spending the time deciding exactly what you want to do for your audience, rather than simply delivering information, will help you fine-tune the content and the design of your document.

Problems caused by not understanding your target audience

Common writing problems often reflect that a writer has not thoroughly considered who their audience is or what they need. This can cause the following problems:

- providing too much (or not enough) detail or background information

- providing too much detail on unrelated sub-topics or on a well-known topic

- using the wrong language or unfamiliar terminology

- assuming the audience’s level of interest in, or understanding of, the topic

One common mistake in science and academic writing is assuming your audience will know your topic nearly as well as you do. The problem with this assumption is that crucial background information and explanation of fundamental concepts may be omitted. Authors of research papers will often make this assumption deliberately if they are writing about a specialised topic. Yet even in these cases, it is not a good habit to omit important background information and project details that are necessary for the reader to understand the context of the research.

Get feedback

It is easy to fall into the trap of thinking that writing is simply delivering information if you are a solo writer, if you are inexperienced or if you don’t get regular feedback on your writing. If you do get regular feedback, it might not be enough if you only get feedback from people who know your topic well as you do; your colleagues or supervisors may ensure you write a scientifically-accurate document but anyone overly-familiar with your topic may not realise that what you’ve written is not clearly written or easy to read.

There are three different types of audiences to consider

An audience is a collective group of readers and for most purposes we need to think about our readers as a group and generalise about what qualities they have. I define three types of audience for most documents: the target audience, the secondary audience and the tertiary audience. For an example of this definition, refer to the diagram below that outlines the hypothetical audiences for an ecological research paper.

Your target audience is your intended audience. They are the group of readers that you want to read your document or you expect will read your document. These are the people you are designing your document for. Your target audience should understand everything you write. Some examples are research scientists writing peer-reviewed papers for their peers, students writing assignments for their lecturers or consultants writing reports for clients.

Your secondary audience are those people who still want, or need, to read your document but may have different education backgrounds or work within a different discipline to your target audience. For example, the secondary audience of an ecological research paper might be scientists from other disciplines, or other people interested in your topic or your project outcomes; for example, land managers, farmers, conservationists, journalists, science educators or students. Your secondary audience may not be thoroughly familiar with your topic but still has a strong or vested interest in your projects’ outcomes. However, it is not possible to cater to both your target audience and your secondary audience with the same document. You cannot cater to the secondary audience as you would need to provide too much detail or instruction, making it tiring for the target audience to read, or worse make the target audience feel the document is not designed for them.

You cannot explain everything for your secondary audience but you can help them navigate your document by defining your key terms and ensuring your main aim and findings are abundantly clear.

Your tertiary audience are people who will directly or indirectly benefit or be affected by your work in some way but will not read your document themselves; they will learn about your work either through the secondary or target audience of your document. Because your tertiary audience won’t be reading your document, it is crucial for you to ensure your key messages are abundantly clear so they are not mis-interpreted or mis-represented.

Key ways to identify and cater for your target audience

  • Think about who your readers are and whether they fit into either of the three audience categories, then focus on how to cater for the target audience. Some factors to consider:
  • Who will want or need to read your document? What reasons do they have for reading your document?
  • Who will be interested in your topic and key findings? Why will they be interested in reading your document? If they are not already interested, how do you attract them?
  • What is their occupation, expertise, background or level of education?
  • Will they be able to understand all parts of your document? If not, include sufficient detail and explanation to ensure that they do or assign them to your secondary audience.
  • What people need to read your document
  • What task(s) will your document perform for them?
  • How they will find out about your document?
  • How will they access your document?

           DOWNLOAD THE INFOGRAPHIC: 6 ways to identify and cater for your target audience

Once you have clearly mapped out who you are writing to and how you will cater to them. If appropriate, ask someone from your target audience to give you feedback on a late draft of your document. You might find there are some important aspects you still need to consider.

Remember:

  • Do not assume your readers know everything you do.
  • Understand there are different types of audiences who may read your document.
  • Always define your key terms and explain your key concepts.
  • If appropriate, ask someone from your target audience for feedback on a late draft of you rdocument.


© Dr Marina Hurley 2020 www.writingclearscience.com.au

Any suggestions or comments please email info@writingclearscience.com.au 

Find out more about our new online course...


SUBSCRIBE to the Writing Clear Science Newsletter

to keep informed about our latest blogs, webinars and writing courses.