Professional Documents
Culture Documents
DOCUMENT DESIGN
AND DEVELOPMENT
BSBADM506
www.gen.edu.au 1
Unit outline
• Unit of competency requirements
https://training.gov.au/TrainingComponentFiles/BSB/BSBADM506_R1.pdf
• Assessment requirements
https://training.gov.au/TrainingComponentFiles/BSB/BSBADM506_Assessm
entRequirements_R1.pdf
www.gen.edu.au 2
Introduction
Creating and using well-designed documents is a key
element of modern business.
www.gen.edu.au 3
Legislation requirements
Managers responsible for producing documents and templates need to be
aware of:
www.gen.edu.au 4
Legislation requirements
• Anti-discrimination legislation - Document design and development
must use inclusive language and not contain any discriminatory content or
provisions
www.gen.edu.au 5
Organisational policies and procedures
• Privacy policy
• Records management policy and procedure
• Quality management policy and procedure
• Continuous improvement
• Professional development
• Occupational health and safety
https://www.youtube.com/watch?v=rlqKB90FmJk
www.gen.edu.au 6
Skills required by manager
• Communication skills - present complex information
clearly and logically
• https://www.youtube.com/watch?v=5n4josMijng
www.gen.edu.au 7
Establish documentation standards
www.gen.edu.au 8
Create and maintain documents
Creating and maintaining documents require commercial or
organisational software packages.
www.gen.edu.au 9
Design format
• Business letters
• Reports
• Forms
• Newsletters
• Memos
www.gen.edu.au 10
Design formats
Specific formatting requirements may include:
https://www.youtube.com/watch?v=vO2Mbyu4NSM
www.gen.edu.au 11
Most common types of documents
The type and number of documents produced will depend on the
nature of your organisation’s business.
Documents produced could include:
• Spreadsheets and databases
• Business letters and forms
• Email, memos and faxes
• Web pages
• Flyers, brochures, newsletters and business cards
• Reports
• Tenders
• Booklets
• Certificates or awards
https://www.youtube.com/watch?v=-4z6LJR5flU
www.gen.edu.au 12
Design and production criteria
• Maintaining a format that is consistent with branding guidelines
• Following a style guide
• Defining a quality standards that covers all elements of
production
• Maintaining content protection through formatting requirements
and legal requirements
• Complying with relevant legislation such as anti-discrimination
and privacy laws
• Prescribing an archiving protocol, including version control
www.gen.edu.au 13
Legal requirements
• Non-gender specific terminology
• Inclusive language (offensive and discriminative)
• Writing in a clear, unambiguous style
• Including privacy declaration
• Including relevant legal notices, disclaimers or copyright notices
• Seeking approval from organisational legal advisers as required
www.gen.edu.au 14
Storing documents
• Follow organisational protocols for filing documents and
templates on the server
• Structure file paths logically
• Comply with legal obligations for archiving documents
• Follow backup procedures to protect documents
www.gen.edu.au 15
Evaluate adequacy of existing IT
structures
• Existing and desired quality levels for documents
• Current and proposed software packages
• Existing IT hardware
• Skill levels for using software packages
• Cost constraints related to producing documents
www.gen.edu.au 16
Software packages for basic documents
• Microsoft Office products
• Apple iWork
• Sun Systems StarOffice
• Corel WordPerfect Office
• OpenOffice products
www.gen.edu.au 17
Software applications
• Desktop publishing
• Word processing
• Spreadsheet
www.gen.edu.au 18
Desktop publishing
Desktop publishing software allows the design and production of typographic-
quality text and images, which are comparable to traditional typography and
printing
Examples:
• Adobe InDesign
• QuarkXpress
• Microsoft Publisher
https://www.youtube.com/watch?v=2bclIK29i9o
www.gen.edu.au 19
Word processing
• Creating, editing, saving and printing text documents.
• Copying, pasting, moving and deleting text within a document.
• Creating and editing tables.
• Inserting elements from other software, such as illustrations or
photographs.
• Correcting spelling and grammar
• Making repetitive tasks easier, such as mail merge.
Examples:
www.gen.edu.au 20
Spreadsheet
• Spreadsheet software is a type of computer program that helps a user
perform numerical functions and analyse numbers through a computerised
version of an accounting worksheet.
• The spreadsheet software captures, displays, and manipulates data
arranged in rows and columns.
• It also allows the creation of graphs and charts, models, fillable forms
such as invoices and payslips.
Examples:
• Microsoft Excel/ Microsoft Office 365 for online collaboration
• Google Sheets
• Smartsheet
https://www.youtube.com/watch?v=OnGAQT7OwCc
www.gen.edu.au 21
Spreadsheet
www.gen.edu.au 22
Software packages for dedicated desktop
publishing
• Microsoft FrontPage
• Microsoft Publisher
• Adobe Creative Suite
• Scribus
www.gen.edu.au 23
Effective documentation
• Appropriate processor size
• Sufficient computer memory
• High resolution printers
www.gen.edu.au 24
Hardware requirements
• Printers
• Scanners
• Digital camera
• Digital video
• CD/DVD writers
• Hard-drive storage
• Networking requirements
www.gen.edu.au 25
Assess cost constraints
www.gen.edu.au 26
Costs for implementation standard
documentation
• Cost of the operator’s time spent keying in information, checking,
correcting and printing the document
www.gen.edu.au 27
Documents that need to be produced
• Spreadsheets and databases
• Business letters and forms
• Email, memos and faxes
• Web pages and intranet content
• Promotional material
• Reports
• Tenders
• Booklets
• Certificates or awards
www.gen.edu.au 28
Identify document requirements
• Involve team members in a brainstorming session
• Identify external and internal documents
• Record how each document is used
• Identify documents created by other departments or
external groups
• Review business plans to identify future requirements
• Consult with senior managers
www.gen.edu.au 29
External sources
• Equipment or software manuals – hard copies or online
version
• The Help function of computer programs
• Search engines such as Google
• Trouble shooting videos on YouTube
• External software developers/ trainers
• Online tutors and tutorials
• Short courses / training programs
• External consultants or experts
www.gen.edu.au 30
For each document, identify
• User of the document
• Purpose of the document
• Required format
• Whether the document can be produced in-house now
or in the future
• Cost of producing the document
www.gen.edu.au 31
Stages of document production
The process of producing documents involves three stages:
www.gen.edu.au 32
Stages of document production – Plan
• Identify organisational needs
• Client needs
• Identify resources:
o Style guides
o Manuals
o Audience
o Purpose
o Medium
www.gen.edu.au 33
Stages of document production –
Produce & publish
Produce stage involves:
• Research
• Draft
• Proofread
• Revise/ rewrite/ approval and version control
Publishing stage involves:
• Present the document in required format
• Distribute the document
• Store the document
www.gen.edu.au 34
Style guide
A style guide outlines the templates and formatting to be used in key
documents.
• Writing style
• Terminology and language
• Grammar
• Spelling
• Punctuation
• Copyright laws
www.gen.edu.au 35
Style guides
Style guides help users to create documents of consistent
high quality.
• Accessible
• Clear
• Concise
www.gen.edu.au 36
Style guides
Style guides address the areas:
www.gen.edu.au 37
Design tasks
• Identifying client requirements for document design
• Liaising with external personnel
• Locating and collecting appropriate information or
precedents
• Using appropriate page layout software
• Applying macros to speed up production
www.gen.edu.au 38
Suit design documents
Ensure standard formats and template meet:
www.gen.edu.au 39
Templates
Templates are established style models used to create documents that:
www.gen.edu.au 40
Format requirements for template
• Size and location of the company logo
• Subject line
• Size and type of font
• Text orientation such as whether text is justified or not
• Use of white space
• Caption requirements for diagrams
• Header and footer information
• Specified inclusions
• Macros
www.gen.edu.au 41
Template for business letter
• Letterhead
• File references
• Formatted text area
• Text font and size
• Layout
• Signature blocks
• Disclaimers
• Copyright notices
www.gen.edu.au 42
Templates
Templates are established style models used to increase production
efficiency and ensure consistency
www.gen.edu.au 43
Templates
To ensure a template meets the document’s purpose:
www.gen.edu.au 44
Use templates
• A simple minutes template for staff meetings but a more complex format
for board meetings
• Different standard letters for an inquiry, overdue payments, customer
rewards, etc.
• A simple signoff for internal emails but a more detailed one for external
use
www.gen.edu.au 45
Research audience
• Use of jargon within the document
• Tone of writing
• Content of document
www.gen.edu.au 46
Information requirements of
documents
• Standard inclusions such as legal disclaimers or
regulatory requirements
• Specific text required for the document
• Any pre-inserted text that may apply to all documents
using the template
www.gen.edu.au 47
Readability
Readability is the ease with which a document can be
read.
Text that is easily read improves comprehension, retention and
reading speed.
• Syntax and semantics (Choice of words, how the words are used)
• Layout design features
https://
support.office.com/en-us/article/video-improve-accessibility-with-heading-sty
les-68f1eeff-6113-410f-8313-b5d382cc3be1
www.gen.edu.au 48
Layout features and design elements
• Font or typeface
• Text spacing
• Use of ‘white space’ (Un used space, separation space of paragraph)
• Margin width
• Justifying text
• Colour
• Backgrounds
• Headers and footers
• Document sign-off
• Logos
www.gen.edu.au 49
Test template
Ensure:
www.gen.edu.au 50
Feedback
Gather feedback by:
• Focus groups
• One-on-one interviews
• Group feedback sessions
• Intranet feedback forums/email
• Suggestion boxes
www.gen.edu.au 51
Incorporate feedback
• Ensure the feedback is relevant and affects the majority
of users
• Follow version control procedures
• Create backup documents to protect original or user-
access documents
www.gen.edu.au 52
Technical functions
Benefit the user to speed up the document production
Understand:
www.gen.edu.au 53
Macros
Macros can improve the quality of documents and allow basic users to access
sophisticated software functions.
Assess macros to determine whether they:
• Save time for the user
• Automate repetitive tasks
• Meet users’ needs
• Comply with organisational standards
https://www.youtube.com/watch?v=8wHDjHt51lk
www.gen.edu.au 54
Create macros
Creators of Macros should ensure that they:
www.gen.edu.au 55
Test macros
• Confirm the macro functions in all relevant software environments
• Confirm the operating environment of all likely users, for example,
internal and external users
• Confirm the functionality always produces the same result
• Consider the impact of antivirus software on the macro
https://www.youtube.com/watch?v=C_rFE9bg1EU
www.gen.edu.au 56
Macros - compliance
Ensure compliance to organisational and legal
requirements:
www.gen.edu.au 57
Access additional information
• An IT Manager/Staff
• Software developer trainers
• Online tutors and tutorials
• Short courses
• External consultants
www.gen.edu.au 58
Instructions to use macros and templates
• Arranging information sessions
• Scheduling training (
https://www.youtube.com/watch?v=WxbOm_x0RQU)
• Developing ‘how-to’ booklets
• Writing information sheets
www.gen.edu.au 59
Instructions
Instructions should be clear, concise and free of technical
jargon.
www.gen.edu.au 60
Tips for effective formatting
• Use a simple and consistent layout
www.gen.edu.au 61
Notes on templates
Explain:
www.gen.edu.au 62
Notes on macros
Explain:
www.gen.edu.au 63
Consistent use of templates and
macros
Ensure consistent use of templates and macros:
• Following an approval process that includes that
checking documents conform with template
requirements
• Using a document register
• Conducting regular audits of documents chosen at
random to ensure they conform to templates
• Conducting regular reviews of templates and updating
them as required
www.gen.edu.au 64
Strategies to understand quality standards
www.gen.edu.au 65
Coaching
• Explaining the process and why it is going to occur
• Demonstrating how to perform the task
• Practising the task
• Correcting the task, making any necessary adjustments
• Trialling the task
www.gen.edu.au 66
Self-directed training
Consider:
www.gen.edu.au 67
Develop training material
Consider:
www.gen.edu.au 68
Master file
A master file is a record containing all the criteria required by the
originator and is saved in a secure location in the organisation’s
information system.
It should be:
• Password protected
• Formatted
• Available
www.gen.edu.au 69
Name master files
Follow organisational protocols for naming master files.
www.gen.edu.au 70
Circulate master files
• Emailing a copy or shortcut to the users of the template
www.gen.edu.au 71
Strategies to use templates by team
members
Check each document produced by a team member until the team
member demonstrates they understand the template and macros to
be used
Discuss templates at a team meeting and providing information
about who to consult as required
Establish or use a document register
Ask a new staff member to describe the templates they using
Circulate a reminder email or memo
www.gen.edu.au 72
Check document quality
Check and confirm that documents:
www.gen.edu.au 73
Periodic monitor of quality control
• Compare documents produced by team members with
master documents
• Evaluate document use and quality
• Evaluate staff knowledge and skills
• Provide training and refresher sessions as required
www.gen.edu.au 74
Audit the documents
• Purpose
• Intent
• Audience
• Readability
• Image
www.gen.edu.au 75
Review templates
Review templates in consultation with key stakeholders:
• Audience representatives
www.gen.edu.au 76
Develop schedules approach
• Motivates users to implement the change in the
required time frame
• Allows for regular monitoring of the implementation
• Makes allowances for feedback and modification
www.gen.edu.au 77
Communicate changes
Communicate changes in templates and documents by:
www.gen.edu.au 78
www.gen.edu.au 79