Why This Role Stands Out
This role offers an excellent opportunity to refine your API documentation skills within the dynamic payments industry, contributing to clear and comprehensive technical resources. You'll thrive here if you possess a keen eye for detail and enjoy translating complex technical information into accessible documentation for developers, making this a fantastic role to explore further.
Quick Overview
Job Description
Role: API Technical Writer (Payments Domain)
Location: NYC, NY – (Hybrid – 3 days onsite per week)
Type: Long Term Contract
Industry: Payments Domain
JD:
Key Responsibilities
- Develop and maintain detailed API specifications for RESTful APIs in payments domain
- Develop all associated artefacts including use cases API testing tools Postman collections
- Collaborate with engineering team product managers and QA teams to gather technical information and develop technical as well as functional documentation essential for client integration
- Ensure documentation aligns with industrys best standards and practices
- Ability to review and edit API documentation for accuracy consistency and usability
- Manage version control and updates of API documentation as APIs evolve
- Advocate for documentation quality and usability within the development lifecycle
- Ability to specify to engineering tools for content management and rendering
Qualifications
- Payment domain experience to analyse documentation requirements from client perspective
- Proven track record of successful involvement with technical API documentation
- Strong analytical ability and deep understanding of API technologies standards and protocols such as OAuth REST JSON XML GraphQL SOAP
- Excellent written and verbal communication skills
- Ability to operate under minimal guidance
- Ability to grasp complex technical concepts to develop clear concise technical documentation
- Ability to draw using Figma and other tools will be added advantage
- Must be familiar with Content Management tools such as Crafter
- Must have working knowledge of Agile development process
-------
Thanks & Regards,
Ashish
Similar jobs
- KA
Technical Writer – Skill Level 2 with Security Clearance
NewKaizen Approach
Annapolis Junction, MD🇺🇸HybridYesterdayMicrosoft PowerPointConfluenceExpress+1Technology - BA
Technical Editor, Mid with Security Clearance
NewBooz Allen Hamilton
Arlington, VA🇺🇸$55.2k - $126k/yrOn-siteYesterdayMicrosoft ExcelMicrosoft OfficeMicrosoft PowerPointTechnology - FC
Content Writer
NewFabuwood Cabinetry Corp
Newark, New Jersey🇺🇸On-site13 hours agoSEOEmail MarketingCopywriting+1Marketing - WH
Copywriter
NewAuto ApplyWhop
Brooklyn🇺🇸On-site19 hours agoTikTokInstagramMarketing - Z5
Senior Proposal Writer
NewAuto ApplyZone 5 Technologies
United States🇺🇸HybridYesterdayMicrosoft ExcelMicrosoft WordMicrosoft PowerPoint+6 - RH
Scriptwriter - Commercials & Social Video
NewAuto ApplyRythm Health
United States🇺🇸RemoteYesterdaySales - VA
Sr. Copywriter (Executive Social)
NewAuto ApplyVaynerMedia LLC
United States- New York🇺🇸HybridYesterdayArticulateCopywritingMarketing - MO
Copywriter
NewAuto ApplyMonks
San Francisco🇺🇸$80k - $95k/yrHybridYesterdayBrand StrategySEOCopywriting+2Marketing - CG
Senior Technical Writer with Security Clearance
NewContact Government Services, LLC
Washington, DC🇺🇸$81.1k - $117.2k/yrHybrid2 days agoMicrosoft OfficeAgileProject ManagementTechnology - TN
Fellow, Opinion Copy Editor
NewAuto ApplyThe New York Times
New York🇺🇸$82.4k/yrHybrid2 days agoEEOCGenerative AI - BG
Group Copy Supervisor
NewAuto ApplyBGBx
United States🇺🇸$125k - $150k/yrHybrid2 days agoBrand StrategyComplianceCopywriting+1 - SC
Technical Writer
SGIC Cloud Technologies Inc.
Sunnyvale, CA🇺🇸Hybrid3 days agoComplianceIllustratorMicrosoft Word+2Technology