About Synechron :
At Synechron, we believe in the power of digital to transform businesses for the better. Our global consulting firm combines creativity and innovative technology to deliver industry-leading digital solutions. Synechron’s progressive technologies and optimization strategies span end-to-end Consulting, Design, Cloud, Data, and Engineering, servicing an array of noteworthy financial services and technology firms. Through research and development initiatives in our FinLabs we develop solutions for modernization, from Blockchain and Artificial Intelligence to Data Science models, Digital Underwriting, mobile-first applications and more. Over the last 20+ years, our company has been honored with multiple employer awards, recognizing our commitment to our talented teams. With top clients to boast about, Synechron has a global workforce of 14,000+, and has 52 offices in 21 countries within key global markets. For more information on the company, please visit our website or LinkedIn community.
Synechron Inc is seeking a Sr Technical Writer - financial services to join our Jersey City, NJ, (onsite 3 days a week is a must in Hybris ) long-term contract.
Position Summary
We are seeking a skilled and detail-oriented Technical Writer with experience in documenting Python APIs and web-based user interfaces. The ideal candidate will work closely with our development team to create clear, comprehensive, and user-friendly documentation. You will be responsible for transforming complex technical concepts into easy-to-understand guides, tutorials, reference material, and API documentation for both technical and non-technical users.
Role:
- Develop and maintain high-quality technical documentation for Python APIs and a web-based GUI, including user manuals, API references, integration guides, and tutorials.
- Collaborate with developers, product managers, and other stakeholders to gather detailed knowledge of the APIs and the use cases they support.
- Write, edit, and update technical content that is clear, concise, and accessible for varying audiences, from developers to non-technical stakeholders.
- Ensure documentation is well-organized and follows best practices in API documentation.
- Create code samples, inline comments, and snippets to demonstrate API functionality and usage in Python.
- Participate in code review sessions, understand code logic, and translate it into easily understandable language.
- Keep API documentation up-to-date with software updates, enhancements, and new feature releases.
- Assist in the creation of quick-start guides, FAQs, and troubleshooting sections for developers using the API.
- Ensure consistency in terminology, formatting, and branding across all technical documentation.
Primary Skill Python
Required Skills
- Proven experience as a technical writer, specifically documenting Python APIs.
- Strong understanding of Python programming language, data structures, and common Python libraries.
- Familiarity with API architecture and formats like REST, JSON, SOAP, or GraphQL.
- Experience with API documentation tools and platforms (e.g., Swagger, Postman, Sphinx, MkDocs).
- Ability to write clean, concise, and accurate code samples in Python.
- Excellent writing and communication skills, with strong attention to detail.
- Familiarity with version control systems (e.g., Git) and experience working in an agile environment.
- Ability to work collaboratively with cross-functional teams.