Skills

Decision-making Architecture api testing Postman

Job Specifications

Technical Writer | API Documentation | Tech for Good Platform (Contract)

Key Info:

£330 per day Outside IR35
4–6 month contract
Remote working
Greenfield API documentation project
High ownership and technical depth
Immediate start preferred

The Role

You won’t be maintaining documentation. You’ll be building it from the ground up. This is a foundational API documentation initiative for a globally used, data-driven platform serving enterprises, financial institutions, governments, and NGOs. The current API layer is mature and business-critical bumt the documentation needs to be created from scratch.

In this role, you will take ownership of structuring, writing, and delivering comprehensive API documentation end to end. You’ll work directly with engineers and product teams to deeply understand system architecture, endpoints, authentication flows, request and response models, and error handling patterns.

This is not a light-touch content role. You will need strong technical depth, confidence working hands-on with APIs, and the ability to independently design documentation architecture that scales.

What They’re Looking For (Non-Negotiables)

3+ years’ experience as a Technical Writer in a SaaS or product environment
Proven experience building API documentation from scratch (not just maintaining or editing)
Strong understanding of RESTful APIs and API architecture
Hands-on experience documenting endpoints, request/response schemas, authentication mechanisms, and error handling
Ability to interpret code, Swagger/OpenAPI specs, or developer conversations without heavy hand-holding
Experience structuring large documentation sets logically and independently
Confidence operating autonomously in a fast-moving product environment

What You’ll Work With

REST APIs and internal service architecture
Endpoints, request/response models, authentication flows, and error handling frameworks
OpenAPI / Swagger specifications
Internal engineering teams across backend and platform
Documentation repositories and knowledge management tools
Release notes and developer-facing technical content

Nice to Haves

OpenAPI / Swagger tooling
Postman or similar API testing tools
Markdown-based documentation systems
Notion documentation
Diagramming tools for system architecture visualisation
Experience reviewing and restructuring legacy technical documentation

Why Join / Projects

This is a rare opportunity to define the documentation standards for a critical API ecosystem used globally. Your work will directly impact how developers, partners, and internal teams interact with the platform.

You’ll have genuine ownership, not incremental edits, but architectural influence over how the API is presented, structured, and understood.

The products support real-world, data-led decision-making with tangible environmental and social impact, giving technical depth meaningful context.

If this sounds like something you are interested in, please apply!

Technical Writer | API Documentation | Tech for Good Platform (Contract)

About the Company

We are Prism Digital, your DevOps and Cloud talent partner. Proud sponsors and co-organisers of the London DevOps meetup group. We are a niche consultancy with a tight focus on driving quality over quantity. We pride ourselves on our consultative approach, our extensive knowledge of the DevOps, Cloud and infrastructure sector and most importantly how important great talent is to help your company grow and succeed. We offer: • Expertise in Cloud (AWS, Azure, GCP), Linux, Windows, CI/CD, Configuration Management, IaC, Cont... Know more