Our client, Broadstone Technologies, is seeking a skilled Technical Writer specializing in API and documentation to join their team in Lahore. This role is ideal for a motivated self-starter passionate about creating clear, concise technical content and eager to tackle new challenges in backend systems. The successful candidate will play a crucial role in producing and maintaining high-quality documentation that supports SaaS platforms and developer tools, helping both technical and non-technical users understand complex technologies.
Key Responsibilities
- Write, edit, and maintain comprehensive user guides, admin manuals, and knowledge base articles for SaaS platforms including Cytex, Veilix, and Vesgo.
- Develop and update API documentation covering endpoints, authentication, and request/response examples for developer-facing products.
- Document security, compliance, and Governance, Risk & Compliance (GRC) workflows in a clear and accessible manner for diverse audiences.
- Produce release notes, changelogs, and product update documentation for each software release.
- Collaborate closely with engineering, product, and QA teams to gather technical details and ensure documentation accuracy.
- Create onboarding guides, FAQs, and troubleshooting materials aimed at reducing support tickets and enhancing user self-service.
- Write internal technical documentation such as architecture overviews, process documents, and standard operating procedures for engineering and cross-functional teams.
- Translate complex subjects like AI/ML models, Zero Trust architecture, encryption, VPN protocols, and compliance frameworks (SOC 2, ISO 27001, GDPR) into understandable content.
- Maintain documentation style guides to ensure consistency in tone, structure, and terminology.
- Work with design and UX teams to integrate diagrams, screenshots, and other visual elements into documentation.
- Support content and marketing teams by contributing to whitepapers, technical blog posts, and case studies as needed.
- Keep all documentation current within a version-controlled system as products evolve.
Required Qualifications
- Proven experience as a Technical Writer in an IT or software company, with strong preference for SaaS environments.
- A robust portfolio demonstrating published technical documentation, user guides, or API documentation.
- Excellent command of written English, with the ability to simplify complex technical, cybersecurity, or AI concepts for various audiences.
- Experience writing API and developer documentation, including REST APIs and SDKs.
- Familiarity with documentation tools such as Confluence, Notion, GitBook, MadCap Flare, or ReadMe.
- Basic knowledge of Markdown and version-controlled documentation workflows (e.g., docs-as-code, Git).
- Ability to collaborate effectively with engineers and product managers to extract and organize technical information accurately.
- Understanding of cybersecurity principles including Zero Trust, VPN/encryption technologies, threat intelligence, and identity/privacy protection.
- Knowledge of compliance and GRC frameworks such as SOC 2, ISO 27001, GDPR, and NIST.
- Basic familiarity with AI/ML concepts relevant to documenting AI-powered features.
- Comfortable documenting products for both enterprise (B2B) and consumer-facing (B2C) audiences.
- Strong attention to detail, excellent organizational skills, and the ability to manage multiple projects and deadlines.
- Proactive and curious mindset, with strong collaboration skills across diverse teams.
- Self-motivated and capable of working independently in a fast-paced technology environment.
- Bachelor’s degree in English, Technical Communication, Computer Science, Journalism, or a related field.
- Minimum of 2 years of professional technical writing experience, preferably in cybersecurity, SaaS, fintech, or AI sectors.
Preferred Qualifications and Benefits
- Exposure to fintech terminology, particularly digital payments and financial data security, is a plus due to involvement with the Vesgo product.
- Opportunity to work in a collaborative environment that values continuous learning, creativity, and ownership.
- Chance to contribute to innovative projects that make a real-world impact while advancing your career in backend technology and technical communication.
Broadstone Technologies offers a dynamic workplace where your expertise will be valued and your professional growth supported. Join a team dedicated to pushing the boundaries of technology through clear, effective documentation.