Technical writing (also known as technical editing, documenting and business writing) is a wide field covering any kind of writing that needs to be clear, precise, accurate and efficient. For example:
- User guides and troubleshooting manuals.
- Tutorials and self-paced learning.
- Customer information sheets.
- Warning information and emergency procedures.
- Business policies and procedures.
- Business tenders.
- Software API documentation.
- Anything else that needs to be clearly and quickly understood.
I have experience creating print, online, e-book and in-app documentation for a wide range of subject matter, including training and assessment material and indexing. I am an accredited editor (Australian Institute of Professional Editors) with a Master's in Publishing and Editing, and have additional Masters' in Computer Science and in Commerce. This gives me an excellent knowledge-base for documenting software, API's, business systems and policies and financial software or procedures.
I used to develop software and I taught computer science at RMIT university for years, so I can read code and understand developers. I can document API's or software using your test cases or the spec that you gave your developers, resulting in much less interruption to your development cycle. I have extensive experience documenting enterprise-level software and architecture, and in assisting agile startups with both documentation and user-interface design.
I have also documented projects well outside my own areas of expertise, including welding aparatus, child care policies and tender applications, and am well-practised at interviewing subject-matter experts to obtain the necessary information. More information is available at my LinkedIn profile.
Contact me with a brief outline of your project and timeline. Please note my services are subject to availability.