I write technical documentation, heuristic reviews and terrible puns.
Project data submission guide
How my technical writing streamlined and standardised submission of critical project data
My client wanted to update a set of occupational profiles tailored for Western Australia, detailing education and training requirements for each occupation, along with additional supporting information.
To ensure clarity, consistency, and efficiency, I liaised with the subject matter experts (SMEs) to standardise their data submissions. One of the results of this effort was the creation of the Occupational Profile Submission Guide. The guide provides structured templates and detailed field instructions for reporting salary expectations, job prospects, education pathways, licensing requirements, and industry resources.
Key elements
-
Templates and structured fields to ensure that complex information is easy to input and retrieve.
-
Writing guidelines that emphasise simple, accessible language.
-
Style guidelines that enforce consistent terminology, formatting, and grammar rules, ensuring all submissions adhere to a professional standard.
-
Instructions that are broken down into easy-to-follow steps, reducing ambiguity.
By creating this document, I streamlined the submission process, reducing ambiguity and minimising the need for revisions. The guide also includes a writing style guide, enforcing plain language principles, proper formatting, and local relevance for Western Australia.
