The Brief
Boost Security is an application security platform built for DevSecOps teams — helping engineering organisations find and fix security issues early in the development lifecycle, without slowing down delivery.
As Manager of Technical Documentation, I own the full documentation strategy: from the getting-started experience that converts a new signup into an integrated team, to the deep API reference that experienced users rely on day-to-day.
The challenge with application security documentation is bridging two audiences simultaneously: the security engineers who configure and manage the platform, and the developers who encounter its output in their pull requests, pipelines, and IDE. Both need documentation, but they’re asking completely different questions.
What I Built
A comprehensive documentation system covering the full Boost Security platform:
- Getting Started — A structured onboarding path that walks new users from signup to their first finding in under 15 minutes
- Integration Guides — Step-by-step setup guides for every major SCM (GitHub, GitLab, Bitbucket), CI/CD platform, and IDE integration
- API Reference — Full REST API documentation with authentication, endpoint references, request/response examples, and error handling
- Scanner Documentation — Per-scanner references explaining what each security rule detects, why it matters, and how to remediate it
- Changelog — A developer-readable changelog that translates engineering release notes into content security and dev teams can actually use
Approach
I treat documentation as a product. That means defining success metrics, running discovery with actual users, and prioritising what gets written based on where the biggest gaps are — not just what engineers most recently changed.
For Boost Security specifically, that meant auditing onboarding drop-off points and rebuilding the getting-started flow around the actual integration steps new users encounter, not the internal architecture of the platform.
Every integration guide is tested in a real environment before it ships. Every code sample runs.
Results
The documentation site serves as the primary resource for engineering and security teams integrating with Boost Security worldwide, with measurable impact on onboarding completion rates and reduction in support volume for integration-related questions.