At a Glance
- Tasks: Create and maintain clear, accurate technical documentation for APIs and new features.
- Company: Join a remote-first company that values collaboration and innovation.
- Benefits: Enjoy 33 days holiday, family healthcare, and your birthday off!
- Why this job: Make an impact by ensuring developers have the resources they need to succeed.
- Qualifications: Experience in technical writing and a solid understanding of APIs required.
- Other info: Flexible working environment with opportunities for rapid career progression.
The predicted salary is between 36000 - 60000 ÂŁ per year.
All BR-DGE Builders Receive The Following Benefits:
- Flexible and remote working
- Remote working allowance
- 33 days holiday including public holidays
- Your birthday as a day off
- Family healthcare
- Life insurance
- Employee assistance programme
- A culture that champions rapid career progression
- Investment in your learning and development
- Regular team events & socials
About The Role:
We are looking for a Technical Writer to take ownership of our developer and API documentation, with a strong focus on ensuring new functionality is documented clearly, accurately, and on time. This is a hands‑on role embedded within our product and engineering workflows. You will work closely with Engineers and Product Owners to shape, write, and maintain documentation as features are delivered, reducing the gap between development completion and merchant‑ready documentation. The role is proactive by design. You’ll work with a visible pipeline of upcoming features, engaging early with design and implementation to ensure documentation is ready when customers need it.
What You’ll Be Doing:
- Establish and run a robust, repeatable process for documenting new product functionality as it is released.
- Own the creation of high‑quality, merchant‑facing documentation for APIs, integrations, and platform features.
- Work directly with Engineers during feature delivery to:
- review design documents
- exercise APIs using tools such as Postman
- ask clarifying questions and validate behaviour
What We’re Looking For:
Core Requirements:- Proven experience writing technical documentation for APIs, developer tools, or complex platforms.
- Strong written English, with excellent attention to clarity, structure, and audience.
- Hands‑on experience using Postman or similar tools to exercise APIs.
- Solid understanding of back‑end concepts such as APIs, authentication, data flows, and environments.
- Comfortable working directly with Engineers and Product teams in an agile environment.
- Ability to drive documentation proactively, rather than waiting for requests.
- Strong organisational skills and ability to manage multiple documentation streams in parallel.
- Experience investigating issues beyond API usage, such as logs, tracing, or database behaviour.
- Background in payments, fintech, or other regulated industries.
- Experience improving or redesigning documentation workflows and publishing pipelines.
- Hybrid backgrounds such as former engineers, Technical Support Engineers, or API specialists who have moved into documentation.
Tools & Environment:
- Documentation platform: ReadMe
- API tooling: Postman
- Close collaboration with Engineering, Product, and Technical Solutions teams
- Access to staging and sandbox environments provided
What Success Looks Like:
Within the first 90 days:- A clear, reliable process for documenting new features is in place and being followed.
- Documentation for new releases is consistently being delivered to a high standard.
- The time between feature completion and merchant‑ready documentation is significantly reduced.
- Documentation quality supports faster merchant adoption and fewer clarification loops with Product and Support.
- Positive feedback about quality of documentation, ease of integration, and our team’s contribution to the successful outcomes of our commercial and implementation teams.
- Reduction in time spent on request servicing, with self‑serve resources enabled to free our Product and Customer Support teams’ time for other high‑value activity.
What We Offer:
- Flexible, remote‑first working
- 33 days holiday, including public holidays
- Birthday off
- Family healthcare
- Life insurance
- Employee assistance programme
- Investment in learning and development
- Regular team events and off‑sites
- A collaborative culture where documentation is treated as a first‑class product
Technical Writer in Edinburgh employer: Comcarde Ltd
Contact Detail:
Comcarde Ltd Recruiting Team
StudySmarter Expert Advice 🤫
We think this is how you could land Technical Writer in Edinburgh
✨Tip Number 1
Network like a pro! Reach out to folks in the industry on LinkedIn or at events. A friendly chat can lead to opportunities that aren’t even advertised yet.
✨Tip Number 2
Show off your skills! Create a portfolio showcasing your best technical writing samples. This gives potential employers a taste of what you can do and sets you apart from the crowd.
✨Tip Number 3
Prepare for interviews by practising common questions related to technical writing and APIs. We recommend doing mock interviews with friends or using online platforms to boost your confidence.
✨Tip Number 4
Don’t forget to apply through our website! It’s the best way to ensure your application gets seen by the right people. Plus, we love seeing candidates who are proactive about their job search!
We think you need these skills to ace Technical Writer in Edinburgh
Some tips for your application 🫡
Tailor Your Application: Make sure to customise your CV and cover letter for the Technical Writer role. Highlight your experience with technical documentation, especially around APIs and developer tools, to show us you’re the right fit!
Showcase Your Skills: Don’t just list your skills; demonstrate them! Include examples of your previous work or projects where you’ve created clear and concise documentation. This will help us see your writing style and attention to detail.
Be Proactive: In your application, mention how you’ve taken initiative in past roles. We love candidates who can drive documentation processes without waiting for requests, so share any relevant experiences that showcase this trait!
Apply Through Our Website: We encourage you to apply directly through our website. It’s the best way for us to receive your application and ensures you don’t miss out on any important updates about the role!
How to prepare for a job interview at Comcarde Ltd
✨Know Your Documentation Tools
Familiarise yourself with documentation platforms like ReadMe and API tools such as Postman. Be ready to discuss how you've used these tools in your previous roles, as this will show your hands-on experience and understanding of the technical aspects.
✨Understand the Product and Engineering Workflow
Research the company’s product offerings and their engineering processes. Being able to articulate how you can integrate into their workflows will demonstrate your proactive approach and readiness to collaborate with Engineers and Product Owners.
✨Prepare for Technical Questions
Brush up on your knowledge of APIs, authentication, and data flows. Expect questions that assess your understanding of back-end concepts, as well as scenarios where you might need to clarify documentation requirements with technical teams.
✨Showcase Your Organisational Skills
Be prepared to discuss how you manage multiple documentation streams and ensure timely delivery. Share examples from your past experiences where you successfully maintained clarity and structure in your documentation while juggling various projects.