Technical specifications and API documentation

Context

The role of Australian Energy Market Operator (AEMO) is to manage the electricity and gas systems and markets across Australia, helping to ensure Australians have access to affordable, secure and reliable energy.

I was part of AEMO’s distributed energy initiatives and a market trial project, working with multiple teams to document a range of content for different audiences.

Opportunity

I was assigned to manage the entire suite of documentation, for two Australia-wide distributed energy initiatives documenting technical specifications, API design, user guides, and reference documentation.

Contribution

Over the course of the two projects, I worked on:

  • Planning, designing and writing project and product documentation for gas and electricity market applications.
  • Collating and editing technical project information from IT, release management and business teams involved in system build, test, and deployment releases.
  • Assisting developers with documenting user interfaces and the gas/electricity data models to help users replicate data between their systems and AEMO’s systems.
  • Creating API documentation for the AEMO Developer Portal.

Technical Spec 1 Technical Spec 1

Project deliverables

Impact

  • Delivered over 700 pages of technical and user content for a range of users across technical and business teams.
  • Created documentation that formed a crucial part of an Australia wide distributed energy project, used by over 20 energy retailers and over 100 installers.

Project link: https://www.aemo.com.au/energy-systems/electricity/der-register

Nifty tech tag lists from Wouter Beeftink