About Me
Who I Am
Professional Background
Before transitioning into technical writing, I served as a Senior Scientist for an international oil producer. In this role, I managed all aspects of planning, project management, operations, and application. Additionally, I engaged in private biosensor research and development, where I communicated complex technical information to investors and other key stakeholders, tailoring content for both technical and non-technical audiences.
This role honed my ability to manage complex projects and communicate intricate technical information effectively.
Where I am now
I am the Lead Technical Writer and Documentation Strategist specialising in API documentation, developer enablement, and technical content strategy.
Since 2022, I have been the sole technical writer at Creditsafe, Operating within an Agile environment, I manage the documentation process in sprint cycles, ensuring timely and high-quality deliverables, enhancing customer experience and streamline developer integration.
Skills & Tools
- Languages: Python HTML CSS JavaScript Markdown YAML JSON
- Tools: Azure DevOps (ADO) AWS API Gateway Postman Realm Platform Integration VS Code Git CI/CD
- Methodologies: Agile (Scrum) Sprint Planning Doc-as-Code
- AI Integration: Leveraging AI tools to enhance documentation and workflows
My Journey at Creditsafe
Creditsafe is a leading global provider of business credit risk and compliance solutions, with a database covering over 430 million businesses across more than 200 countries.
Upon joining Creditsafe, I encountered minimal and unmanaged API documentation. Recognising the critical need for comprehensive, user-centric documentation, I took full ownership of the project. My approach is rooted in a customer-first philosophy: understanding client needs, assessing current development stages, and bridging the gap with clear, actionable knowledge.
Key Achievements:
- Comprehensive Documentation Overhaul:
- Independently audited and tested every API endpoint from the customer's perspective.
- Collaborated with product owners and development teams to ensure accuracy and relevance, creating all missing documentation single-handedly.
- Led the end-to-end transformation of the API documentation platform, aligning it with company strategy and customer needs.
- Customer-Centric API Portal:
Designed and developed a new API documentation portal that segments the API into individual products. Features include:- Interactive in-browser testing
- Downloadable OpenAPI specifications
- Multi-language code examples
- Process flows
- Product Specific Guides
- Integrated feedback mechanisms to identify and address customer pain points
- Doc-as-Code Implementation:
Transitioned documentation to a Doc-as-Code approach, integrating it into the CI/CD pipeline. This ensures real-time updates and maintains alignment with ongoing software developments. - Internal Knowledge Empowerment:
Established a self-service API catalog for internal teams, standardising documentation processes and reducing dependencies on direct developer interactions.
Strategic Leadership
In my role, I engage with executive leadership to align documentation initiatives with Creditsafe's overarching business objectives. By collaborating closely with cross-functional teams.
By bridging the gap between technical teams and C-level management, I ensure that documentation initiatives drive business growth and enhance user engagement.
Approach & Philosophy
I believe that exceptional documentation is the cornerstone of a positive user experience. By immersing myself in the user journey, I ensure that our documentation is not only informative but also intuitive and accessible. My goal is to make our API offerings fully self-service, minimising the need for external support.
Future Goals
I am committed to continuous improvement and innovation. My future objectives include:
- Enhancing developer experience (DX)
- Integrating AI-driven solutions into documentation practices
- Conducting API usability research to further refine our offerings
I thrive on bridging the gap between complex technical concepts and user-friendly content, ensuring that our documentation serves as a powerful tool for both customers and developers.
For a closer look at the API documentation portal and its features, please visit: Creditsafe API Documentation
Connect with me on LinkedIn