How to Improve your Technical Writing Skills
Transcript of How to Improve your Technical Writing Skills
![Page 1: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/1.jpg)
VPELA’s Young Professionals together with seminar host Urbis
present
How to Improve your Technical Writing Skills
Speakers: Alice Maloney, Senior Associate Planner, Ratio
Natasha Swan, Manager City Planning, Monash City Council
Eliza Minney, Associate, Best Hooper Lawyers
YPG proudly sponsored by
![Page 2: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/2.jpg)
Alice Maloney
Senior Associate Planner, Ratio
![Page 3: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/3.jpg)
How to improve your technical writing skills
YPG Masterclass
Alice Maloney
![Page 4: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/4.jpg)
Four main components to writing:
• Planning
• Writing
• Editing
• Re-writing
![Page 5: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/5.jpg)
Planning
• why are you writing?
- planning permit triggers (traffic, heritage, vegetation removal, flooding issues etc)
- planning policy (ie – WSUD / ESD)
• who are you writing for?
- planning consultant
- Council planner
- Councillors
- VCAT
- Referral Authority
- residents / general public
• what do you want the reader to do?
![Page 6: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/6.jpg)
Writing
- think about structure – make it easy to read / follow
* diagrams (a picture is worth a thousand words)
![Page 7: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/7.jpg)
* tables – easy dissemination of information
![Page 8: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/8.jpg)
* dot points
* appendices (lengthy assessments, technical data)
- less is more – keep it succinct
- use plain English / language (ease up on Shift + F7)
- grammar & punctuation
- clear conclusions / summary / findings / advice
![Page 9: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/9.jpg)
Editing
Proof-reading – making sure to check:
• Is the purpose clear?
• Has content and style been tailored for the reader?
• Have you written clearly & concisely?
• Explain any technical language / jargon
• Are sentences / paragraphs short & easy to follow?
• Check punctuation, grammar and spelling
• No clangers – typos / cut & paste hangovers
![Page 10: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/10.jpg)
Re-writing
• Incorporate any changes / edits
• Clear summary
• Reissue final report
• Get planning permit
![Page 11: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/11.jpg)
Natasha Swan
Manager City Planning, Monash City Council
![Page 12: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/12.jpg)
How to improve your technical writing skills
A Council approach
![Page 13: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/13.jpg)
Council Planners
• Know your audience
• Set the scene
• Define the policy regime
• Provide for an assessment
• Balance competing views
• Respond to community concerns
![Page 14: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/14.jpg)
Council Planners – Know your audience
• Who is likely to read this report
• What level of understanding is necessary to make a decision
• What will a future decision maker or resident make of the report
• Language should always be plain and to the point
![Page 15: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/15.jpg)
Council Planners – Set the scene
• Not an advocate of a particular interest but still an advocate none the less
• What are the key elements– Where is it and why is that important?
– What about the site is relevant later when you get to the assessment?
– What is it?
• What actually needs a permit
• What is the history of the site
![Page 16: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/16.jpg)
Council Planners - Policy
• What are the policy considerations broadly
• Which part of policy is the most critical
• Is the policy in one place or bits and pieces
• What are the policy tensions
![Page 17: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/17.jpg)
Council Planners - Assessment
• Considered the nuts and bolts
• Detail varies from Council to Council so know your expectations
• Hard bit is balancing competing interests
– Traffic vs landscaping
– Native vegetation vs bushfire
– Architectural presentation vs function
![Page 18: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/18.jpg)
Council Planners – Community Response
• Try and avoid technical or dismissive responses
• Be clear why something is not covered by planning
• Offer acknowledgement of personal issues raised and by sympathetic
![Page 19: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/19.jpg)
Council Planners – Community Response
Objection
“The building will damage my property”
• Rather than – ‘this is not a planning issue’ –try…
![Page 20: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/20.jpg)
Council Planners – Community Response
Protection of adjoining properties forms part of the building approval process. The developer has legal responsibilities to assess the condition of adjoining properties and to issue protection notices to ensure these are not damaged during construction.
![Page 21: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/21.jpg)
Council Planners – Community Response
Objection
“The building will take away all the light in my garden where I spend most of my time”
• Rather than – ‘the proposal complies with the overlooking requirements of Clause 55.04-5’ – try…
![Page 22: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/22.jpg)
Council Planners – Community Response
It is acknowledged that there will be some additional shadow caused to the neighbours garden. The plans indicate that for the most part this is confined to a small lawn area under the clothesline and importantly the outdoor seating area and vegetable garden are free of additional shadow impacts
![Page 23: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/23.jpg)
Eliza Minney
Associate, Best Hooper Lawyers
![Page 24: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/24.jpg)
HOW TO IMPROVE YOUR TECHNICAL WRITING SKILLS
ELIZA MINNEY, ASSOSCIATE
BESTHOOPER LAWYERS
![Page 25: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/25.jpg)
1. VCAT• Applications for Review• Amended Plans• Expert Evidence
2. Writing Submissions
![Page 26: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/26.jpg)
1. VCAT – Applications for Review
1. Name of Applicant
2. Proposal
![Page 27: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/27.jpg)
1. VCAT – Applications for Review continued
3. Permit Triggers
![Page 28: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/28.jpg)
1. VCAT – Applications for Review continued
4. Statement of Grounds
• Refusal
• Conditions appeals
• Objecting to an Application
![Page 29: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/29.jpg)
1. VCAT – Expert Evidence
• Recommendations
• Numbered paragraphs
• Conclusions
• Practice Note
![Page 30: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/30.jpg)
2. Writing Submissions – Permit Applicant
1. Confirm relevant matter details
2. Background and policy context
3. Permit triggers
4. Key issues and response
5. Conclusion and permit conditions
![Page 31: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/31.jpg)
2. Writing Submissions – Council
1. Council’s processing
2. Policy context
3. Internal referrals, advertising and responses
4. Submissions in relation to each issue, policy and merits based assessment of same
5. Conclusion and conditions
![Page 32: How to Improve your Technical Writing Skills](https://reader031.fdocuments.net/reader031/viewer/2022020707/61fe995c9f9ec1642c10bbcf/html5/thumbnails/32.jpg)
2. Writing Submissions - Objectors
• Don’t need policy/processing background
• To the point, key issues