Insight Global
Technical Writer- Data and Gen AI
Insight Global, Plano, Texas, us, 75086
Insight Global is looking for a meticulous and skilled Technical Writer to join our team for a major financial client. The role involves documenting Python APIs and web-based user interfaces. The ideal candidate will collaborate closely with our development team to produce clear, comprehensive, and user-friendly documentation. Your responsibilities will include:
Developing and maintaining high-quality technical documentation for Python APIs and a web-based GUI, including user manuals, API references, integration guides, and tutorials.Working with developers, product managers, and other stakeholders to gather detailed knowledge of the APIs and their use cases.Writing, editing, and updating technical content that is clear, concise, and accessible to both technical and non-technical audiences.Ensuring documentation is well-organized and adheres to best practices in API documentation.Creating code samples, inline comments, and snippets to demonstrate API functionality and usage in Python.Participating in code review sessions to understand code logic and translate it into easily understandable language.Keeping API documentation up-to-date with software updates, enhancements, and new feature releases.Assisting in the creation of quick-start guides, FAQs, and troubleshooting sections for developers using the API.Ensuring consistency in terminology, formatting, and branding across all technical documentation.
We are a company committed to creating diverse and inclusive environments where people can bring their full, authentic selves to work every day. We are an equal opportunity/affirmative action employer that believes everyone matters. Qualified candidates will receive consideration for employment regardless of their race, color, ethnicity, religion, sex (including pregnancy), sexual orientation, gender identity and expression, marital status, national origin, ancestry, genetic factors, age, disability, protected veteran status, military or uniformed service member status, or any other status or characteristic protected by applicable laws, regulations, and ordinances. If you need assistance and/or a reasonable accommodation due to a disability during the application or recruiting process, please send a request to HR@insightglobal.com .
To learn more about how we collect, keep, and process your private information, please review Insight Global's Workforce Privacy Policy: https://insightglobal.com/workforce-privacy-policy/ .
Required Skills & Experience
Demonstrated experience as a technical writer, particularly in documenting Python APIs.Strong grasp of Python programming, including data structures and common libraries.Proficiency with API documentation tools and platforms (e.g., Swagger, Postman, Sphinx, MkDocs).Excellent writing and communication skills with a keen eye for detail.Familiarity with version control systems (e.g., Git) and experience in an agile environment.Ability to work effectively with cross-functional teams.
Benefit packages for this role will start on the 31st day of employment and include medical, dental, and vision insurance, as well as HSA, FSA, and DCFSA account options, and 401k retirement account access with employer matching. Employees in this role are also entitled to paid sick leave and/or other paid time off as provided by applicable law.
Developing and maintaining high-quality technical documentation for Python APIs and a web-based GUI, including user manuals, API references, integration guides, and tutorials.Working with developers, product managers, and other stakeholders to gather detailed knowledge of the APIs and their use cases.Writing, editing, and updating technical content that is clear, concise, and accessible to both technical and non-technical audiences.Ensuring documentation is well-organized and adheres to best practices in API documentation.Creating code samples, inline comments, and snippets to demonstrate API functionality and usage in Python.Participating in code review sessions to understand code logic and translate it into easily understandable language.Keeping API documentation up-to-date with software updates, enhancements, and new feature releases.Assisting in the creation of quick-start guides, FAQs, and troubleshooting sections for developers using the API.Ensuring consistency in terminology, formatting, and branding across all technical documentation.
We are a company committed to creating diverse and inclusive environments where people can bring their full, authentic selves to work every day. We are an equal opportunity/affirmative action employer that believes everyone matters. Qualified candidates will receive consideration for employment regardless of their race, color, ethnicity, religion, sex (including pregnancy), sexual orientation, gender identity and expression, marital status, national origin, ancestry, genetic factors, age, disability, protected veteran status, military or uniformed service member status, or any other status or characteristic protected by applicable laws, regulations, and ordinances. If you need assistance and/or a reasonable accommodation due to a disability during the application or recruiting process, please send a request to HR@insightglobal.com .
To learn more about how we collect, keep, and process your private information, please review Insight Global's Workforce Privacy Policy: https://insightglobal.com/workforce-privacy-policy/ .
Required Skills & Experience
Demonstrated experience as a technical writer, particularly in documenting Python APIs.Strong grasp of Python programming, including data structures and common libraries.Proficiency with API documentation tools and platforms (e.g., Swagger, Postman, Sphinx, MkDocs).Excellent writing and communication skills with a keen eye for detail.Familiarity with version control systems (e.g., Git) and experience in an agile environment.Ability to work effectively with cross-functional teams.
Benefit packages for this role will start on the 31st day of employment and include medical, dental, and vision insurance, as well as HSA, FSA, and DCFSA account options, and 401k retirement account access with employer matching. Employees in this role are also entitled to paid sick leave and/or other paid time off as provided by applicable law.