Plan Complex Documents

Submitted by sylvia.wong@up… on Wed, 01/20/2021 - 13:17
When documents are not written or planned correctly, they usually end up filled with unnecessary information.

Most people dislike reading disorganised and incoherent text. Because of this, every writer must include planning in the writing process.

Planning is one of the most essential stages in writing an effective document. It helps you determine who your audience is, your objectives, and why you are writing the document. When writers plan, they usually note the document's required format, style, and structure; this is important because it helps them communicate with their audience better. It also helps them clarify their thoughts and determine what they want to achieve.

The planning process

diagram of planning process
  • Step 1: Determining the document's audience, requirements, and purpose
  • Step 2: Determining its required format, style, and structure
  • Step 3: Establishing a method of communication
  • Step 4: Developing an overview of the document
  • Step 5: Finding data that confirms something is worth reading.

We will look at each of these steps in detail in this topic.

Sub Topics
Business manager sitting at a desk in a modern office typing a document on a desktop computer
Determine to whom and why you are writing your document before you even begin writing.

Whilst the length, format, and order of the document may vary according to what you are trying to achieve, there are similar basic requirements in every document. This includes following your organisation's policies, procedures, and preferred format. This will help to ensure consistency and productivity while writing. When writing complex documents, it is always essential to determine your document's audience, purpose, and requirements before writing.

Let us consider each of these in more detail.

Audience

Knowing your audience is an essential part of the planning process. It is too easy to forget who you are writing to when you are engrossed in writing your document. However, this can be avoided when you consider who your audience is. You must first determine who you are writing to so you establish how your document will appear in writing. Your document needs to be reader-friendly, which is why you must ensure that you have a specific audience in mind. Remember, the way you write can impact how they understand what you have written.

Writing documents always involves rhetorical decisions (the way words are used to persuade the audience). For example, the way you address an executive in a business letter will differ from how you address your colleagues in an email. Knowing who your audience is can help you adjust how you approach certain situations based on your audience's expectations.

Purpose

Your purpose is the single reason for writing your document and refers to what you intend to achieve. Selecting your goal is a crucial step in writing. Expressing your purpose in one clear and concise statement will clarify your thoughts and prepare you for the next steps. Keep a note of your purpose in clear view while working to check to ensure you are not drifting off course. If you discover that your writing has taken you in a different direction, stop and reassess what you are trying to achieve.

The various uses of documents that you will learn about in this unit include:

  • Conveying research findings
  • Influencing attitudes, opinions, and beliefs
  • Meeting legal requirements
  • Meeting other data, information, or knowledge needs of an audience
  • Proposing recommendations, options, and actions.

Select the headings to learn more about each.

Information about research findings communicates results to other researchers, funders, policymakers, and the public. Often, these are lengthy and incorporate significant amounts of technical information. Generally, you will not be looking at extensive technical issues but rather the basic reporting format that applies to all reports.

These documents will contain arguments and information. They could range in length, depending on the message and intended audience, from an email to a report.

Again, the length of these documents will vary according to the purpose, but will all be dated, use formal language, and may use many words and phrases which you will require assistance to understand fully. They usually require a signature and often a witness to that signature. Always use black ink when writing or signing legal documents.

The transference of data, information or knowledge may take many forms. Short amounts of data may be included in a memo or email, and there may be an attachment of other longer documents. If there is substantial information, a report may be required or a public presentation or speech.

To propose a recommendation, you may have to do so at a meeting, or you may be able to present the background, information, and recommendations in a written format.

Requirements

Choosing the right style, format, and structure can help you make an excellent first impression on your readers. They can also help you convey a sense of professionalism when writing your document. Each document type has requirements, whether it is a specific format, writing style, or genre.

You can communicate your thoughts better by following the requirements set by your organisation. These requirements of documents may include those in the following list.

  • Genre
  • Proformas and standard reporting requirements
  • File types and sizes
  • Languages other than English
  • Layout and format
  • Writing styles
  • Visuals and graphics
  • Page numbers
  • References, citations and footnotes
  • Rules and conventions
  • Policies and procedures
  • Style guides.

Let us look at each of these in more detail.

Genre

A 'genre' is a socially agreed upon and recognised form of communication that people have developed over time to communicate more effectively and efficiently with one another. There are many communication genres, including speech genres and genres of writing. An email message would be an example of a genre of writing.

A genre consists of formatting and structure.

  • Formatting: Formatting refers to how the contents of a document are arranged and laid out on the page and whether the contents are visually appealing based on their arrangement and layout and the styles used to present the information (i.e., font style, use of lists and columns, spacing, etc.). Formatting can be reproduced as a template, however, a template provides little or no assistance to writers for generating the content of their documents.
  • Structure: The term' structure' refers to the set of topics that readers of a particular genre of writing expect to find included. When you imagine an outline or a table of contents for a document, you also imagine a structure. Structures can help writers generate and organise their documents' content. The structure is made up of sections, subsections, paragraphs, sentences, lists.

When you need to write an unfamiliar document at work, collect similar documents produced by others in the organisation. Observe these documents to determine what they have in common, how they differ and most importantly, why they differ when they do.1 The level of formality you write with should be determined by your audience's expectations and the document's purpose.2

Proformas and standardised reporting requirements

All organisations have fixed rules, regulations, and requirements. Understanding how these are implemented is a crucial step in the planning process.

  • Proforma: A proforma is most often used to describe a practice or document provided as a courtesy and tends to be performed routinely and is considered a formality. For example, a commitment to customer satisfaction statement at the end of all emails.
  • Standardised reporting requirements: Standard Business Reporting (SBR) is a standard approach to online or digital record-keeping that the Australian government introduced in 2010 to simplify business reporting obligations. SBR incorporates common terms in government legislation and reporting. These terms link to terms in the business/accounting software creating consistency for business and government.
File types and sizes

Most businesses will have preferences for the types of files that can be sent or stored online. This especially applies to graphic files. The size may also be important because the sending and receiving systems must have the capacity to send and receive. If there is a need for items to be altered (or not) will impact the choices of software used. For example, if nothing is permitted to be changed, you would convert a file to PDF. Ensure that you are clearly aware of and strictly adhere to the requirements of your business.

Languages other than English

Microsoft Office supports the typing and editing of text in any language supported by Microsoft Windows. Although your Microsoft Office program tries to automatically identify each piece of text that you type with the correct language, there are things you can do to assist. Microsoft Windows and Microsoft Office should be set up with the necessary functionality and settings before working with text in another language.

However, your organisation may prefer to use a translation service. Regardless, professional proofing is essential.

Format and layout

Formatting refers to how the contents of a document are arranged on the page. This concerns whether the contents are visually appealing based on their arrangements and layout. It also concerns the styles used to present the information (i.e., font style, use of lists and columns, spacing, etc.).

Factors to consider when formatting your document include:

  • graphics placement
  • margin size
  • indentation use
  • text justification.

Your document's layout refers to the overall look of your page – from the typefaces you choose to your effective use of white space. The term 'white space' refers to empty space on the page. White space shows your organisation and section breaks visually. It also emphasises important ideas and presents your ideas in more manageable bits. Readers react favourably toward white space. For example, readers would be more inclined to read one that set out the main points with headings and indentations.

The following table lists points of comparison to help you distinguish a well-formatted document from one that is poorly formatted.

Point of comparison Well-formatted document Poorly formatted document
Readability A well-formatted document directs the reader's eyes to the information that follows a previously read passage. This makes it easier for readers to understand the complete thought of the text. A poorly formatted document makes it difficult for readers to identify which information follows what was previously read. This makes it difficult for readers to understand what the writer intended to say with the document.
Cohesion A well-formatted document uses uniform standards for formatting (e.g. font size, font). This allows readers to know that each document's content is related to each other and aims to discuss the same things. A poorly formatted document uses different standards for different parts of the text. If the formatting becomes too different, readers would have trouble understanding if individual sections are still connected.
Appearance A well-formatted document is visually appealing. It directs a reader's eyes efficiently from one section of the document to the next. The chances of readers reading the content of the document also increase. A poorly formatted document looks disorganised and unprofessional. Readers may dismiss the document without reading the content.
Over the shoulder view of a business analyst writing a report based on financial data displayed on a laptop
Visuals and graphics

Including visuals in your document helps attract readers and enables you to save space when writing text. Visuals help link knowledge and raw data together. When using visuals in your document, ensure that they are:

  • appropriate
  • able to be interpreted correctly
  • artfully arranged
  • labelled, titled, or captioned
  • properly cited and referenced.
Page numbering

All documents that are more than a couple of pages long should have page numbers and a contents list (table of contents) linking page numbers to sections of the text. Long letters, memos, or faxes will also need page numbers. Numbered sections will also provide quick access when discussing the report with somebody who may ask you to look at a specific section. You must also remember to outline your document's content according to your organisation's preferred style.

References, footnotes, and citations
  • References: A referencing style is a set of rules telling you how to acknowledge the thoughts, ideas, and works of others in a particular way by citing your sources. Referencing is a crucial part of successful business writing.
  • Footnotes: Footnotes are superscript numbers 1, 2, 3 placed within the body of text. They can be used as a form of citation in certain citation styles or as a provider of additional information.
  • Citations: A citation is a formal reference to a published or unpublished source that you consulted and obtained information from while writing.

There are different referencing styles, including APA (American Psychological Association) or Harvard. Your organisation will have a preferred option.

Rules and conventions

When it comes to writing in English, it is always important to follow standard rules and conventions.

  • Rules: In writing, rules refer to a set of guidelines that must be followed whenever specific conditions are met.
  • Conventions: Conventions, on the other hand, refer to grammar, spelling, sentence structure, punctuation, and capitalisation. They help make your writing comprehensible and understandable.

When writing in English, consider the following. Select each reading to read more.

The term 'jargon' refers to any in-group or specialised language used by small groups of like-minded individuals. This terminology is usually specialised to the function of the group. When choosing what vocabulary to use, you should first consider the audience that you are addressing. If you are writing for a general audience, you should avoid using in-group jargon without explanations. Overloading your audience with words they do not understand will not help you achieve your purpose.2 For example, if you are writing about fitness trends to an audience unfamiliar with fitness, you might introduce and explain a few essential terms.

If you are writing to an in-group audience, you will want to use group-specific jargon. Not using the jargon when your audience expects it can signal to the audience that you are not a group member or have not mastered the group's terminology.

You should avoid using slang (words like 'awesome' or 'cool') or idiomatic expressions (such as 'pull someone's leg,’ 'spill the beans,' and' something smells fishy') in formal writing. These words make your writing sound informal, and hence, less credible. Furthermore, for non-native speakers of English, these expressions may prove more challenging to understand because of their non-literal nature.

Times do exist, however, when the use of slang and idiomatic expressions are appropriate. Think about who your audience is, what they expect, and how the use of these words may help or hinder your purpose. If you are writing a very informal or humorous piece, slang or idiomatic expressions may be appropriate.

Language can be perplexing when it is overly complex or confusing. Confusing language is used to downplay the truth or to evade responsibility. Here is an example:

The acquisition of pollution permits by individuals and corporations that produce toxins has now been allowed by the recently amended Clean Air Act of 1990. Institution of permits simplifies and clarifies obligations for business and industry, making environmental protections more accessible for these constituents. The government and the Environmental Protection Agency will be greatly assisted in their endeavours by monitoring the release of all substances and having the substances listed on one individual permit.

Although this paragraph makes it seem like this facet of the Clean Air Act is helping the environment, the EPA, and the federal government, all it is doing is explaining the new permit system that allows permit holders to release pollutants into the environment.

However, depending on your purpose, some terms that may be considered euphemisms may be appropriate or even sanctioned by groups they affect. For example, it is more proper to say 'persons with disabilities' or 'differently-abled persons' than to call someone 'handicapped’ 'crippled' or even 'disabled.' In these cases, it is essential to use what is considered correct by the group in question.

Avoid using language that is stereotypical or biased in any way. Discriminatory language frequently occurs with gender and can also offend people based on sexual orientation, ethnicity, political interest, or race. Stereotyped language is any that assumes a stereotype about a group of people.

Writing in a non-sexist, non-biased way is both ethically sound and practical. Non-sexist writing is necessary for most audiences; if you write in a sexist manner and alienate much of your audience from your discussion, your writing will be much less effective.2

Writing styles and Plain English

Writing styles

Select the following headings to learn about the four common writing styles.

Expository writing generally shies away from bold opinions or value judgments, instead delivering straightforward information and data. It can inform or instruct readers about a subject, but in its purest form, it's not out to change anyone's mind.

Examples of expository writing include:

  • news articles
  • nonfiction books
  • textbooks
  • scientific and medical research
  • instruction manuals
  • cookbooks.

This style typically includes quotes, links, citations for sources, and tables and charts to highlight key data points. Expository writing that involves instructions ideally keep them brief, easy to understand and may include illustrations.3, 4

Descriptive writing often uses metaphors, as well as adjectives, adverbs, and language that activates the reader's senses. It also describes minute details. Places you will find descriptive writing include:

  • poetry
  • diary entries
  • nature writing
  • within a longer piece of writing.

On its own, descriptive writing is usually brief but may be used in other styles such as narratives.3, 4

A business owner writing a report on a notepad

The narrative style of writing tells a story. Its hallmark is a plot with a beginning, middle, and end, like so: Romeo and Juliet's families loathe each other. The two star-crossed lovers fall for each other anyway. Tragedy ensues.

Examples of narrative writing include:

  • novels
  • creative nonfiction (e.g., magazine features)
  • screenplays
  • biographies
  • mythology.3, 4

This writing style sets out to win its audience over to a certain point of view. It builds an argument by presenting evidence and justifications to back up an opinion which may lead to a call to action. Examples of persuasive writing include:

  • academic papers
  • opinion and editorial writing
  • advertising copy
  • product reviews
  • cover letters and letters of recommendation.

Persuasive writing can incorporate or even resemble other styles. For instance, a political speech may include narrative elements, telling the story of a candidate; and while expository writing sets out to deliver information, persuasive writing uses facts selectively to build its case. 3, 4

Note, however, that writers may produce text that combines these styles. Recognising different styles and discerning what a given piece of writing aims to accomplish will help you become a critical reader and a stronger writer. The following video is a light-hearted presentation on the four writing styles. It is aimed at school students, but the information supports what is outlined in the previous table.

What is plain English?

Plain English is a style of writing in which the language, structure, and presentation of a document all work together to help the reader. A document written in plain English is easy to read, understand, and act upon after just one reading.5 When writing in plain English, you should:

  • use correct spelling, punctuation, and grammar
  • use short sentences and paragraph
  • use headings and breaks to signal or signpost sections
  • avoid unfamiliar jargon or provide definitions of jargon or specialist terms
  • use tables, visuals and graphics where appropriate to replace or support text.

Apps such as Grammarly can also assist you to write in plain English.

Policies and procedures

What do they mean?

  • Policies: Policies are statements that state a set of principles that help organisations achieve their set goals and objectives. They are a precise plan of action that guides the decisions and achieves outcome(s). They clearly state the goals and conditions and are like a report in length. They are also formally written and may use very technical language.
  • Procedures: Procedures, meanwhile, are a list of steps an employee must adhere to when completing a particular task or activity defined by an organisation. They are detailed actions that must be executed in the same manner to obtain the same result described in the policy. These are written to make the policy workable and achieve the intention of the policy.

It is easy to get confused by the differences between policies and procedures. Refer to the following guide to differentiate policies from procedures:

Point of comparison Policies Procedures
Frequency of change Rarely changes once finalised and implemented Frequently changed and updated for continuous development
Conditions needed for best implementation  Best implemented when all employees fully accept the requirements written within it  Best implemented when they are created and listed in a logical process that can be easily followed
What it reflects Reflects and supports the fulfilment of an organisation's mission statement Represents a policy statement's practical application

If you are unsure of the policies or procedures that apply to documentation in your workplace, ask a more experienced co-worker to assist or refer to your organisation's guidelines or manuals.

Style guides

A style guide is a set of standards for the writing, formatting, and design of documents. It is used to guide internal or external communications or documentation, for example, in marketing and branding. Like policies and procedures, they provide rules and guidance, including planning, drafting, and finalising documents. A style guide encourages a standard approach to write a document and keep a consistent format, style, and structure. It may provide templates for completing documents.

Scenario

As they diversify into other fitness-related markets, the management at Bounce Fitness wants consistent branding and a more contemporary and professional image for the organisation. They see communications and marketing as two areas where this can be achieved. They have created the Bounce Fitness Style Guide to improve the consistency of all written communication, including internal and external reports, letters, business cards, PowerPoint presentations, business cases, business letters, Emails and meeting agendas and minutes.

They also believe that a consistent approach with information in one location (the Bounce Fitness Style Guide) will help staff write more efficiently and effectively. The style guide provides staff with templates for these documents.

Look at the Bounce Fitness Style Guide and check what is listed in the Table of Contents. You will notice it reflects much of what we have discussed on this topic.

A small business owner sitting at a desk working on a business document on a laptop
A style guide encourages a standard approach to writing a document and help you keep a consistent format, style, and structure.

In this topic we will discuss further:

  • what is meant by format, style and structure
  • the purpose of a style guide
  • the purpose of templates.

We also discuss the key features of written communication methods, including those in the following list.

  • General emails
  • Procedures
  • Business letters
  • Meeting agendas
  • PowerPoint Presentations
  • Business cases
  • Reports.

Your document's visual appeal affects how your message is conveyed to your audience. Your audience will more easily understand what you are writing if it is presented in a visually appealing way. When it comes to how your text is presented, it is essential to consider your document's required format, style, and structure.

The following sections will discuss these requirements.

Format

As mentioned, formatting refers to how the contents of a document are arranged and laid out on the page and whether the contents are visually appealing based on their arrangements and layout and the styles used to present the information (i.e., font style, use of lists and columns, spacing, etc.). Your organisation may have specific formatting requirements such as using a specific font or the way you use bullet lists. The format may also depend on the purpose of the document. For example, a profit and loss statement will use a particular way to record numerical figures.

Standard formatting conventions

  • Traditional fonts such as Calibri, Times New Roman or Arial
  • Font sizes 10-12 font size
  • Left-aligned text
  • Single-spaced paragraphs
  • Consistent line spacing
  • Short headings use a larger bold font.

Capitalisation

Capitalisation will vary between writer preferences and organisational requirements. Many contemporary style guides require minimal use of capitalisation in written texts. Let us look at the general formatting guidelines on capitalisation in the Bounce Fitness Style Guide.

  • Use capitalisation on proper names, including names of a department, e.g., Operations Department and at the beginning of sentences.
  • Do not capitalise job roles/titles in between sentences, unless used as a form of address, e.g., Director John Murphy, Governor Edwards. Otherwise, it should be in lowercase.

The following video will expand on how to format a business document. Note the emphasis on consistent formatting.

Style

The term style can be used in several ways. Firstly, style can refer to the four common writing styles:

  • Expository (straightforward information and data)
  • Descriptive (detailed)
  • Narrative (storytelling)
  • Persuasive (present evidence and justification to back up an opinion and which may lead to a call to action).

The following tables lists when these styles may be applied but remember a document may contain more than one style!

Style Document
Expository Financial report, sales report
Descriptive Market analysis, incident reports, project plan
Narrative Promotional materials, testimonials
Persuasive Business case

However, when writing documents, the term 'style' is used more broadly and distinguishing the difference between a document's format and style can often be confusing.

Style also focuses on the format of citations. For example, people in scientific fields of study use the APA style in writing to report or review research. They use this writing style since it quickly cites scientific sources and encourages a straightforward communication approach. Businesses will generally use the Harvard referencing style.

The following video from Swinburne explains how to reference using the Harvard Style Referencing Guide.

Standard writing style

There are standard writing style criteria that apply to any document type.

  • Use language that is appropriate for the audience and purpose of the document
  • Explain the purpose of the document
  • Present ideas and information logically
  • Use headings and numbering to signpost information
  • Use visuals and graphics that are appropriate for the document
  • Use appropriate referencing style
  • Use templates where available
  • Refer to your organisation’s style guide.

Structure

There are different ways to define ‘structure’. When you imagine an outline or a table of contents for a document, you also imagine a structure. Structures can help writers generate and organise their documents' content. In this topic, we use the term ‘structure’ to refer to how a document is organised or sequenced into logical and predictable graphical parts. The sections will appear in the Table of Contents.

Standard document structure

  • Sections
  • Subsections
  • Paragraphs
  • Sentences
  • Bulleted lists.

Key features of written communication methods

General emails

Email is an abbreviation of electronic mail and is used to send small amounts of information. This can be expanded by using the attachment function to attach documents. It is usually reserved for less formal communication but the use in a formal sense is growing and gaining approval.

Emails can be formal or informal text, but both will include specific criteria.

  • From: Your email address
  • To: The receivers email address
  • CC: Carbon Copy. This will be the email address of the receiver you would like to carbon copy into this email. Carbon copy simply means to include someone to receive the email which it is not formally addressed to but needs to be included in the communications.
  • BCC: Blind Carbon Copy. The email address of the receiver you would like to blind carbon copy into this email. Receivers in the ‘To’ or ‘CC’ sections cannot see receivers in the ‘BCC’ section.
  • Subject: The subject of the email.
  • Message: This will include a greeting to address the receiver, the message in the body of the text, and an email closing. The formality of the email will depend on who your audience is, and the message you are sending to them.

General procedures

There are many templates for creating procedures and every organisation will have their preferred format, style and structure. However, the following Bounce Fitness template for writing a procedure provides a systematic way to write a procedure.

Procedure Title

Short and straightforward. It must reflect what the instructions are about  

Written in title case, e.g., Instructions for Scanning Documents, or How to Scan Documents.

Purpose of the Procedure    Describe why the procedure was created and when it must be followed 
Audience    Include who must follow the procedures listed. 
Related policies and procedures or other information sources    List any related policies and procedures, legislation, relevant information such as websites or videos. 
Procedure  
  • Use a numbered list (i.e., 1, 2, 3…) to write the steps.  
  • Steps must be written in a logical, step-by-step order.  
  • Use simple sentences and words to write instructions.  
  • Start your instructions with action words, e.g., Open the file from your computer.  
  • Use boldface to emphasise important points in your steps.  
  • Visuals or images may be used but need to comply with the Style Guide.  

General business letters

When writing business letters, remember to keep things short, simple, and accurate. It is also important to strictly follow the formats in which they are written. The block format is the most common layout being used when writing business letters. It consists of eight main parts.

  • Letterhead: Letterheads are commonly found at the very top of business letters. They contain the business logo of the sender company, the company name, as well as where the company is located. This can be a full or shortened address (containing only the state/territory). The letterhead should also contain your information. Here, you can write your name, job title, email address, phone number, company name, and return address.
  • Current date: Including the current date is important because it informs the recipient of when the letter was sent. This is useful since it helps them know when they should respond, and it also helps them document your correspondence.
  • Inside address: The inside address includes the recipient’s name, position, and address. When writing your recipient’s name, always remember to include personal titles like Mr., Dr., Engr., or Ms., especially for cases wherein the recipient’s name is not available.
  • Salutation: Salutations are found right before the message body. This section identifies the recipient of the letter. Recipients listed can be very specific, such as a single person and their position in their company, a team or department, or it can be left vague if the sender is unsure as to who to address the letter to.
  • Body: A letter’s body contains your purpose in writing your document. For business letters, always remember to keep your message short and simple. You can begin your letter with a friendly opening before transitioning into your main purpose.
  • Closing: Closing statements usually appear two lines below your body’s last line. Examples of closures include Yours truly, Regards, Sincerely, and Best wishes. Always remember to capitalise only the first letter of your closing statement and end the line with a comma.
  • Signature: Signatures are placed at the very end and indicate the end of the letter. This contains information about the sender such as their name, position, and often also contains the sender’s contact details for the recipient’s response. Remember to affix a signature at the end of your document. Allot about four to five spaces for your signature and use only blue or black ink.
  • Identification: Your identification should contain your typed name with your title located below it. You can also affix your email address or phone number instead of your title if you wish.

Here is a sample letter for reference.

Diagram of a sample letter

General meeting agendas

Meeting agendas are written to discuss the topics covered in a meeting. A meeting agenda has three main parts.

  • Basic information: This part contains your meeting’s date, start time, and location. It is important to include these in your meeting agenda because they inform your attendees of where and when your meeting is. Without this, attendees might miss the meeting or arrive late.
  • Agenda details: Your agenda details contain your meeting’s goals. Here, you may identify the expected time frame each goal should be discussed. You may also identify the speakers who will be leading each discussion.
  • End of meeting review: This contains your meeting’s end time and a recap of what was discussed in your meeting. Here, you may also identify areas in the discussion that may need improvement. You may also identify things that you and your team did well during the meeting.

Here is a sample general meeting agenda for reference.

Date: June 15, 2020

Time: 2:30pm

Location: Conference Room B

Attendees: Vanjie Mateo, Robert Lee, Anna Parker, Brad Michaels

Agenda Details:

Goals: Review the project completed for the previous month, identify areas that need improvement, brainstorm ways to increase productivity in the workplace.

1. Review the projects completed for the previous month

Time: 45 minutes

Purpose: share information on completed projects for the month of May

  • Present a  list of projects completed last month
  • Identify time taken to complete each project
  • Identify areas that need improvement
  • Brainstorm ways to increase productivity in the workplace

Speaker: Vanjie Mateo

END OF MEETING REVIEW

Time: 15 minutes

Purpose: Discuss what went well in the meeting and what should be done in the next meeting

Speaker: Vanjie Mateo

General PowerPoint presentations

Organisations will usually provide a template for PowerPoint presentations that include a preferred format, style and structure. A standard logo will be provided and text boxes may be set up with a prescribed font. A recommended standard format includes:

  • limiting content to at least two sentences or three to five bullet points per page
  • using font sizes 30pt or larger
  • limiting font styles (italics, bold, underline) to at least one per slide
  • including headings and subheadings (if required)
  • using plain English and language suitable for the audience.

There are three main steps to creating a PowerPoint presentation.

  1. Select the title page, and add images if required
  2. To duplicate the slide for including body text, go to the top menu bar then ‘Insert > Duplicate Slide’. This will create a new slide with the body page style.
  3. Create your presentation.

General business cases

Business cases are written to capture the rationale for initiating a task, project or other business activity. They should be presented in a well-structured written document and often accompanied by a presentation (for example a PPT presentation to senior management). There are different templates for writing a business case which can range from simple to highly complex documents. They all provide a structure for researching and presenting a clear and comprehensive document to stakeholders.

Your business case should include four major sections. Select the headings to learn more about each section.

This section must contain a summary of the main points of the business case. This section must cover all the important information covered in your business case and provide sufficient context to your reader

Your finance section must be on a new page and include specific subsections.

  • Financial appraisal: Information found in the financial appraisal must include the financial implications for the project and a comparison of project costs against forecasted benefits. This is to ensure that the project is affordable and is worth its value for money. This is also to assist in predicting cash flow. Financial risk should also be documented.
  • Sensitivity analysis: A sensitivity analysis must include project risks and their estimated impact on project outcomes. This provides a list of possible scenarios that must be taken into consideration for this project.

This is the largest part of the business case. This section contains details relevant to the project sponsor, stakeholders, and project team. This section must also answer the why, what, and how questions about the project. This section must contain the following subsections:

  • Background information: Your background information must provide a clear introduction to the business case and your project. This includes a brief overview of the reasons why you are proposing this project. You can refer to relevant projects and documentation in this subsection if necessary.
  • Business objective: This subsection includes the reasons why you are doing the project. This includes your goal, materials needed to overcome the problem, and how the project will support the business strategy.
  • Benefits and limitations: This subsection includes both the benefits and limitations of the project. The benefits written in this subsection must include both financial and non-financial benefits.
  • Option identification and selection: This subsection must include a list of potential solutions to the problem. These solutions must be described in sufficient detail. This must show how these solutions will be demonstrated and provide explanations for any unfamiliar terms.
  • Outline plan: This subsection must provide a summary of the main project activities and the overall schedule for the project. The main project activities must include a brief description and a list of major deliverables required.
  • Risk assessment: This subsection must include a summary of significant project risks, opportunities, and how they are managed.
  • Purchasing strategy: This subsection describes how the project will be financed and whether major financial decisions should be taken by the organisation before purchasing. This also includes the purchasing process used for this project.

This is the last section of your business case. When writing your project organisation, you must describe how the project is set up. This includes the following subsections:

  • Project governance
  • Progress reporting.

Project governance includes the following information:

  • Roles and responsibilities
  • Project tolerances
  • Project standards
  • Review points
  • How decisions are made

After writing your project governance, write the progress reporting subsection. This must describe how project progress is recorded and how the project board will be updated on project performance.

Note: Depending on the scale and complexity of your business case, you may not need to provide the Project Organisation.

Reports

Reports are formally structured and communicate the findings of an investigation in a clear logical way6

A report is a piece of informative writing which means that the audience wants to find out information and sometimes act on the information provided in the report. Business reports are formal or problem-solving reports. Your investigation may be a series of observations at work, a site visit to a supplier, or research into a process or a new product or service. They will all need to report specific information.

A business report will have specific sections based on the requirements of the organisation and the purpose of the report. However, they will typically include most of the following sections. To learn more about each select the following headings.

  • Title page:  A title page shows your name, report title and date it was completed.
  • Contents page:  The contents page is an outline of the structure of the report. It lists the headings and subheadings and the page numbers they start on.

An executive summary is commonly found in business reports and contains a sentence or two about the key problem, the objective of the report, possible solutions to the problem and recommendations. You do this last as it summarises the whole report. It should only be no longer than one page (depending on the length of the report).6

The introduction introduces the context of your investigation and explains what you have been asked to explore, why this is important and how you will respond to the ‘brief’. The introduction will focus more on the reasons for writing the report and the context.

In a business report you may not be discussing results but analysing the information you have gathered to assess a course of action or a problem.

Summarise the key points you have made and give the crucial ‘take away’ message you want to leave your readers with. It answers the question ‘So what’? Do not introduce any new information.

Recommendations let the reader know what actions you think should be taken as a result of the research. They are usually written as bullet points (to make them stand out). Be consistent with the tense and grammatical structure for each recommendation.

The references contain the full list of any information/sources you have referred to in the body of your report. Compile your references as you write and avoid last-minute panic! Check when proofreading that any sources referenced (cited) within the body of your report appear in the references (and vice versa).

  • The appendices are the last part of the report and can include anything else you think is useful for the reader, such as raw data, your survey questions (but would also ‘disrupt’ your report if you added in the body of the report and blow out the word count).
  • Make sure you have referred to each appendix in the body of your report.
  • The appendices are arranged in the order they are referred to in your report (for example, ‘See Appendix A for the survey questions’.)
  • Each appendix should start on a new page.6
Using visuals and graphics

Writing reports is as much about visual communication as it is about written communication! Much of what a reader learns from a report is conveyed through the structure which includes the headings, lists and bullet points and through findings which are usually conveyed in tables, graphs and diagrams.

The following table lists common visuals and where they are good to use and where not.6

Type Good for Not good for
Tables Presenting exact numbers Showing overall trends
Line graphs Showing changes over time or how two variables interact Showing precise numbers
Bar charts Showing comparisons between the total amounts in different categories Showing complex multiple comparisons on a single graph
Pie charts Showing large-scale relative proportions Showing the size of the whole ‘cake’, total figures of fine differences in proportions
Photos Illustrating what things look like in real life Detailed and precise technical representations
Diagrams Representing complex processes and detailed information in visual form Showing ‘real life’ three-dimensional perspectives
Maps and plans Showing spatial representations and geographical locations Showing ‘real life’ three-dimensional perspectives

When it comes time to review your draft and final documents check it has a predictable and logical structure. Pay attention to how the content is laid out on the page, and the sequence used to present information to the reader.

Templates

Templates can also assist by providing a pre-determined structure to follow. A template is a file that serves as a starting point for a new document. The purpose of using templates is to save time and provide consistency. In other words, a template controls the overall format, style and structure of a document. It also provides the framework that brings together common elements, modules and components.

The Bounce Fitness Style Guide provides the required structure for the most common organisational documents, listed below.

  • Reports
  • Letters
  • PowerPoints
  • Business case
  • Emails
  • Agendas
  • Meeting minutes
  • Procedures.

Methods of communication usually refer to verbal, non-verbal, written, visual and listening communication. In this topic, we discussing written communication and refer to the methods we identified previously.

  • General emails
  • Procedures
  • Business letters
  • Meeting agendas
  • PowerPoint Presentations
  • Business cases
  • Reports. 

Written communication occurs daily, so it is essential to know how to communicate your purpose clearly and effectively. In addition to choosing the most appropriate method to suit the purpose and audience, you must also choose software that will help you write and communicate your preferred communication method.

Common software

There are many types of software that are available in the market today. Each type has its purpose of assisting you in achieving your goals.

MS Word

Microsoft Word or MS Word (often called Word) is a graphical word processing program that users can type with. It is made by the computer company Microsoft. The purpose of MS Word is to allow users to type and save documents. Similar to other word processors, it has helpful tools and functions to create documents.7

  • Font: This function allows a user to change the styles (e.g., bold, italic, etc.), design, size of the words in their document. This function also allows the user to add specific effects (such as adding shadows or an embossing effect) to the words in their document.
  • Bullets: This function emphasises or highlights certain words, sentences, or phrases by putting them in a list and preceding them with a heavy dot or another such symbol.
  • Header and footer: These allow the addition of text or even graphics in the upper and bottom margins of a page. These are used to indicate page numbers.
  • Spell-check: This function enables the user to catch spelling errors in the document easily.
MS Excel

Excel is a spreadsheet program in the Microsoft Office system. You can use Excel to create and format workbooks (a collection of spreadsheets) to analyse data and make more informed business decisions.8

Adobe InDesign

Adobe InDesign is a popular app used by graphic designers to create projects in digital and print formats. It is made for creating magazines, newspapers, flyers, posters, brochures, and various types of documents, images, and illustrations. You may download Adobe InDesign on both Mac and Windows computers.

MS PowerPoint

When you create a presentation using PowerPoint, the presentation is made up of a series of slides. The slides that you create using PowerPoint can also be presented as overhead transparencies or 35mm slides. In addition to slides, you can print audience handouts, outlines, and speaker's notes.9A PowerPoint template is a pattern or blueprint of a slide or group of slides you save as a .ptx file. Templates can contain layouts, theme colours, theme fonts, theme effects, background styles, and even content. You can create your custom templates and store, reuse, and share them with others.10

The design of a text must cater to its content. However, the design must also be geared to what you can do with your software. It is no good planning a multi-column document if you do not have the software to produce one. Ensure that you are informed of the different types of desktop publishing software to match what you use with what you want to make.

Desktop publishing software

There are three different classes of desktop publishing software.

  • Word-processing: This type of software is commonly used for more straightforward documents. Word processing software is also used for correspondence and for finalising text.
  • Drawing: Drawing software is used for creating visuals, graphics, drawings, digital art, and other illustrations. What makes this type of software great is that it allows you to isolate and move some aspects of a picture.
  • Page makeup: This type of software is used to make complex layouts, reports, and tables. It is also used in preparing posters or charts that combine pictures with small amounts of text. If you combine software, check carefully for compatibility; make sure your page makeup software will take in text and illustrations from your word-processing and drawing software.
An employee sitting at a desk typing a business document on a laptop

Your content is the most essential part of your document. A content overview helps you organise the data you want to present in your document. It lists out the ideas you want to convey to your audience (often through bullet points or numbered lists). Think of your content overview as your strategy in creating your document. It helps you:

  • identify your target audience, purpose and goals in writing your document
  • tailor your content to suit your audience better
  • identify and refer to relevant information sources.

Because of this, always ensure to create a content overview before you begin writing.

Basic 5-step step model to create a simple content overview

Developing a content overview does not happen overnight. It takes time to think of ideas and link them together. The steps to creating a content overview will depend on organisational requirements and what the organisation considers essential to include. The five steps to creating a content overview are shown in the following table.

Step Description
Step 1: Brainstorm topics you might want to cover in your document

The first and most essential step to creating a content overview is thinking of what you want to write.  

You can begin brainstorming content for your document by thinking of keyword phrases of topics you might want to talk about. There is no need to be specific during this step. You only need to jot down any idea you have that may make for a good piece of writing.

Step 2: Narrow your topics down to your main idea After brainstorming potential ideas that you might want to write about, you may then begin narrowing these ideas down. Narrow your ideas down based on what you think matters most. You may establish the idea you choose to go with by basing your content's body on your chosen topic. Here, you may also bullet points or headings of what you want to discuss per chapter or section of your document.
Step 3: Create an outline of the subtopics you want to discuss The next step to creating general bullet points for your document's body is to develop subtopics that will help you expound on your discussion. Here, you may add levels beneath your main topic. Doing so will help you narrow down what you want to discuss. The more detailed your subtopics are, the less time you will spend comparing your content to your sources. You may also choose to add even more levels to your outline if you want to make your discussion more specific.
Step 4: Think of a title

After you get an idea of what you want to write about, you may begin thinking about your document's title. When creating your document's title, ensure that it catches your audience's attention. A compelling title should be: 

  • short and catchy  
  • reflect the tone of your writing  
  • describe your content 
  • contain key words.
Step 5: Think of the introduction and conclusion

Once you think of a title and have bulleted your headings and subheadings, you may begin writing your document's introduction and conclusion. Your introduction and conclusion are essential parts of your document.  

  • Your introduction informs your audience of what they can expect from your document. 
  • On the other hand, your conclusion reminds your audience of what your paper's all about and why your topic is important.

Scenario

There are occasions when staff must develop complex documents or communications of a sensitive or commercial nature. Ashley, a fitness manager at Bounce Fitness, must write a report on a staff member's performance and his claim for unfair dismissal, which will need to be approved by the HR manager. Ashley's manager asks for an overview of what will be included in the report. Ashley wants to make sure the information is accurate and informed but is unsure where to begin! Ashley is referred to the Content Overview template (in the Bounce Fitness Style Guide) with instructions for those documents that require careful consideration, planning, reviews and approvals. It contains two parts that cover organisational requirements and an overview of the topics to be included in the document.

The template includes the following fields with an explanation:

Part A: Provides organisational requirements
Type of Document Each Content Overview must have a different type of document identified. For example, General Email, Business Letter, Policy, Procedure, Meeting Agenda, Meeting Minutes
Application This can include the following applications: Word processing application (e.g., MS Word, Google Docs), Email application (e.g., Gmail, Outlook)
Method of communication Written communication methods include General Email, Business Letter, Policy, Procedure, Meeting Agenda, Meeting Minutes, Posters
Title of document Provide a clear precise title
Purpose of Document Purpose refers to the reason for creating each document.
Audience Audience refers to the individuals or groups who are the intended readers of the document.
Related policies and procedures or other information sources This refers to any related organisational policies and procedures, including the Bounce Fitness Style Guide. May also include information from other reputable sources including government websites.
Visuals and graphics Identify the type of visual or graphic. Visuals and graphics are optional and their inclusion will depend on the purpose of your document. They may include photos, pie charts, flow charts, illustrations and drawings.
Format, Style, and Structure Identify if the format, style and structure are standard or non-standard per the Bounce Fitness Style Guide.
Part B: Content Outline Identify the topic and subtopic headings that you will cover in more detail in your Draft and Final documents. Use bullet points to indicate topics and their corresponding sub-topics.

Ashley can see that the template provides a systematic way to plan out the document and makes it easy for the manager to see Ashley's direction before the draft is started. 

How information is selected and presented can impact how your message is conveyed to your audience. Readers can easily misunderstand your message if your information is presented poorly or incorrectly. Because of this, it is important always to be aware of how you collect and present your information to avoid misunderstandings and conflicts with your audience.

Selecting information

Maintaining an unbiased opinion on your subject plays a significant role in writing documents. Regardless of what type of document you are writing, one should remain objective and avoid presenting a personal preference when communicating your purpose. Select the following headings for tips on selecting and using information free from bias.

When you are selecting data that may help you in your writing, you must always use credible sources, for example:

  • trustworthy websites (.gov, .edu)
  • material published within the last ten years
  • research articles and materials by respected and well-known authors
  • material from Google Scholar
  • sites ending in .gov refer to government sites. While these sites generally contain credible information, be cautious about potential bias.
  • sites ending in .edu refer to university websites. These websites usually provide credible content.
  • sites ending in .ac refer to academic institutions. This may refer to institutions like colleges, universities, and research institutes.
Not so trustworthy

Materials you should review and consider judiciously before using may include Wikipedia (although this is a good starting point for finding initial ideas about a topic, not all information can be considered credible). Other may include:

  • sites that may appear to be reliable sources for Wikipedia, but aren't
  • blogs, posts on social networks (e.g. Facebook, Tweets, personal websites or discussion forums
  • research articles or papers without citations
  • websites ending in .com, .org, .net etc.

Selecting data often means going through countless sources. However, not everything you encounter can be used in writing your document. Ensure to go through your sources and sort what can and cannot be used.

Comparing the information and the order you plan to present can help ensure that your data is compelling and convincing. Comparing information can also help you determine which source can best match your document's content. You will find it easier to write once you are familiar with your sources and how you want to present this information.

Always ensure to select the information that conforms to your document's proposed structure, content, and requirements. Doing so will make the writing process easier for you and save you time. It is easy to lose track and get confused with information, especially from various sources. Ensure to keep track of what you collected and match this information with the requirements of your document.

Scenario

Margaret is preparing to write a business case for establishing a partnership with a physiotherapist. She needs to provide the potential partner with a strong argument for partnering. To do this she needs credible information to support her argument. She creates a spreadsheet listing every source of information she thinks will bolster her arguments and then rates the information source as 'Credible' or 'Not credible'. This will help Margaret select the most credible information to read in more detail and determine how it might be used in her business case. 

Classifying data

What is data? The term data is used in different ways, and so definitions vary considerably. Data can be described as facts, figures, or information stored in or used by a computer; or facts, figures or information found in evidence, records, statistics, etc., from which conclusions can be inferred.

When writing a complex document, you must always classify your data according to the category to which they belong. This will significantly help you with writing a cohesive document that is easy to read. Data can be categorised into two categories.

  • Qualitative or categorical data
  • Quantitative or numerical data.

These are briefly described.

Qualitative or categorical data

Data under this category would describe the qualities or characteristics of something discussed or observed. This kind of data is observable and difficult to count or measure accurately. Examples of this can include colour, quality, names, or sex.

Qualitative tools and techniques 

  • Interviews
  • Groups
  • Autobiography
  • Observations
  • Written documents.
Qualitative tools and techniques
Quantitative or numerical data

Data under this category would answer questions that relate to exact measurements or quantities. This data is often collected and presented using instruments that show accurate measurements, including rulers, thermometers, or questionnaires with rating scales.

Scenario

Margaret has written her first draft of a business case for establishing a partnership with a physiotherapist. She has identified credible sources of information including two Australian government research reports on the benefits of physiotherapists working collaboratively with fitness trainers. She adds another column to the spreadsheet to classify the data from the two reports. The data from the first report is based on qualitative research and identifies the total number of gym participants by age and gender. Margaret classifies this data as quantitative (or numerical). The second report reports on interviews with gym members recovering from injury describing the benefits of having a physiotherapist visit during their gym sessions. Margaret classifies this as qualitative (or categorical data). She intends to refer to these classifications in her business case.

Sequencing data

Always follow a logical sequence when presenting your ideas. For context, a sequence refers to succession or order. In writing, this refers to how your thoughts are arranged throughout your paragraphs. There are several commonly used sequences when writing:

  • Chronological
  • Order of importance
  • Cause and effect.

What do these mean? A brief description follows.

Chronological

Chronological sequences refer to an order of time. Under this method, one must first identify how they want to present data according to the time it occurred – from present to the oldest data or from the oldest up to the present. After deciding on that, data can then be ordered based on when they occurred.

This sequence is helpful when you want to arrange your thoughts in steps. They can also be used to enumerate points in your argument. You can use transitional devices when using this type of sequence. For example, you want to enumerate reasons why dishwashing soap must be used in wash plates and might write:

People should use dishwashing soap for many reasons. First, dishwashing soap is mild. It will not irritate your skin or cause allergies. Second, dishwashing soap is cheaper than other household cleaners. You can easily buy them at any supermarket. Lastly, dishwashing soap is a good disinfectant, and it can be used for many purposes.

Compare this to when you want to provide instructions on how dishwashing soap can be used to wash plates.

  1. First, gather all your dirty dishes and put them in your sink.
  2. Second, rinse all the dirty dishes with water.
  3. Third, use dishwashing soap to remove dirt from your plates.
  4. Lastly, wash your plates and arrange them on your dishrack.
Order of importance

Data ordered using this method is based on how important they are to the reason for the presentation. Data can be ordered from most to least important or from least important to most important.

Cause and effect

Data ordered using this method is first categorised into 1) data that occurred first and thus caused a change and 2) data that occurred because of the change, in other words, the effect. Data that caused change are then often presented first to build up to presenting the data that occurred afterwards.

The different ways of sequencing information can prove to be very useful in writing complex documents. You must never forget to match your chosen sequence depending on the type of document you are writing. For example, you may also choose to follow a cause-and-effect sequence when writing a report or a paper.

Scenario

Margaret has written her second draft of a business case for establishing a partnership with a physiotherapist. She has used credible sources of information and identified the data categories. Her final step is to sequence the information and data she has collected in a logical sequence. She decides to use a cause and effect sequence. She presents information that describes gym members who are recovering from injuries and their experience before and after physiotherapist visits to the gym. 

Key points for this topic

  • Your purpose is the single reason for writing your document.
  • You must first determine your audience so you can establish how your document will appear in writing.
  • You can communicate your thoughts better by following the requirements set by your organisation (for example, in a style guide)
  • Communicating your purpose involves using the best software that will help you write your document.
  • Regardless of what type of document you are writing, you should remain objective and avoid presenting a personal preference when communicating your purpose.

The final activity for this topic is a set of questions that will help you prepare for your formal assessment.

Main Topic Image
A business developer staring pensively at a complicated web of diagrams on a glass wall
Is Study Guide?
Off
Is Assessment Consultation?
Off