Technical Writer

Position SummaryWe 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.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.Required SkillsProven 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.Desired SkillsExperience with automated documentation tools (e.g., Sphinx, pydoc).Familiarity with cloud services, CICD pipelines, and other DevOps tools.Previous experience in technical writing for developer tools or open-source projects.Bachelor's degree in Computer Science, Technical Communication, or a related field.Offered Salary Range: $85,000 - $90,000annumWe areAt 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 Artificial Intelligence, Consulting, Digital, Cloud & DevOps, Data, and Software 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 Artificial Intelligence and Blockchain 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,500+, and has 55 offices in 20 countries within key global markets.We can offer you:A highly competitive compensation and benefits packageA multinational organization with 55 offices in 20 countries and the possibility to work abroad.Laptop and a mobile phone10 days of paid annual leave (plus sick leave and national holidays)Maternity & Paternity leave plansA comprehensive insurance plan including: medical, dental, vision, life insurance, and long-short-term disability (plans vary by region)Retirement savings plansA higher education certification policyCommuter benefits (varies by region)Extensive training opportunities, focused on skills, substantive knowledge, and personal developmentOn-demand Udemy for Business for all Synechron employees with free access to more than 5000 curated coursesCoaching opportunities with experienced colleagues from our Financial Innovation Labs (FinLabs) and Center of Excellences (CoE) groupsCutting edge projects at the world's leading tier-one banks, financial institutions and insurance firmsA flat and approachable organizationAn excellent working atmosphere: regular drinks, sports activities, offsite weekends with a young, dynamic teamA truly diverse, fun-loving and global work cultureSYNECHRON'S DIVERSITY & INCLUSION STATEMENTDiversity & Inclusion are fundamental to our culture, and Synechron is proud to be an equal opportunity workplace and is an affirmative action employer. Our Diversity, Equity, and Inclusion (DEI) initiative "˜Same Difference' is committed to fostering an inclusive culture - promoting equality, diversity and an environment that is respectful to all. We strongly believe that a diverse workforce helps build stronger, successful businesses as a global company. We encourage applicants from across diverse backgrounds, race, ethnicities, religion, age, marital status, gender, sexual orientations, or disabilities to apply. We empower our global workforce by offering flexible workplace arrangements, mentoring, internal mobility, learning and development programs, and more.All employment decisions at Synechron are based on business needs, job requirements and individual qualifications, without regard to the applicant's gender, gender identity, sexual orientation, race, ethnicity, disabled or veteran status, or any other characteristic protected by law.

Created: 2024-10-27