Technical Author / Writer

Job Specification: Technical Author / Writer

Role Overview

We are seeking a Technical Author / Writer to produce clear, accurate, and accessible technical documentation to support the delivery and adoption of an API-centric digital platform within a regulated environment.

You will produce a range of documentation, including API specifications, developer guides, operational user guides, onboarding materials, and supporting technical artefacts to enable effective platform integration and use by varied stakeholders, including developers, technical integrators, operational teams, and non-technical stakeholders.

Key Responsibilities

Documentation Development

• Develop comprehensive

  API specifications

  , including:
• Endpoint definitions and usage examples
  
• Authentication and security models
  
• Data structures and payload examples
  
• Rate limits and error handling guidance
  
• Produce

  developer guides

  and integration documentation to enable third parties to connect efficiently to the platform.
• Create clear operational guides for internal and external users, including:
  
• Onboarding materials for retailers and local authorities
  
• Troubleshooting guides and FAQs
  
• Workflow and process documentation
  
• Develop supporting artefacts such as sequence diagrams, architecture diagrams, and data flow illustrations to aid understanding.
  
• Ensure all documentation aligns with plain English, accessibility, and GOV.UK style standards where appropriate.
  

Collaboration

• Work closely with product managers, solution architects, developers, and technical SMEs to ensure accuracy of technical details.
  
• Liaise with policy, legal, and compliance teams to ensure documentation reflects regulatory requirements and data protection obligations.
  
• Collaborate with content designers and user researchers to test documentation with target user groups for clarity and usability.
  
• Engage with support and operational teams to gather insights on common issues to be reflected in documentation and troubleshooting guidance.
  

Iteration and Publication

• Manage structured feedback and review cycles across technical, policy, and compliance stakeholders.
  
• Maintain clear version control across drafts and published documentation.
  
• Prepare documentation for staged publication, supporting phased platform testing and roll-out.
  
• Contribute to training materials and knowledge transfer resources, leveraging technical documentation for operational readiness.
  

Essential Skills and Experience

• Proven experience as a Technical Author, Technical Writer, or Documentation Specialist producing technical documentation in an API-centric product environment.
  
• Experience writing clear and structured

  API documentation, developer guides, and operational technical guides

  .
• Ability to translate complex technical specifications into accessible documentation for both technical and non-technical audiences.
  
• Understanding of accessibility standards (WCAG) and plain English principles in documentation.
  
• Strong attention to detail, ensuring consistency, clarity, and technical accuracy across all materials.
  
• Experience collaborating effectively with multidisciplinary teams, including developers, architects, policy teams, and user researchers.
  

Desirable Skills

• Familiarity with OpenAPI / Swagger and related API documentation tooling.
  
• Experience using diagramming tools such as Lucidchart, Miro, or Visio to produce technical illustrations.
  
• Experience with content management and collaboration platforms such as Confluence or SharePoint.
  
• Understanding of public sector digital standards and familiarity with GOV.UK style guidelines.
  
• Knowledge of API security models and integration considerations within regulated environments.
  

Why this role

This role offers the opportunity to contribute to a nationally significant programme, creating high-quality technical documentation that will directly support developers, integrators, and operational stakeholders in successfully adopting and using an API-centric platform within a regulated environment. You will play a key role in ensuring effective platform integration, compliance, and operational readiness.

• Competitive salary and benefits package.
  
• Unlimited Opportunities for professional growth and development.
  
• Collaborative and supportive work environment.
  
• Flexible working hours
  
• Work life balance
  
• Onsite opportunities
  
• Retirement Plans
  
• Team Building activities
  
• Visit us @ https://www.ve3.global