Insight Global - Chicago, IL

posted 3 months ago

Full-time
Chicago, IL
Administrative and Support Services

About the position

A large financial organization based in Cincinnati, OH is seeking a Technical Writer/Analyst for a 6-month contract opportunity through the end of the year, with potential for extensions. This position has a strong preference for candidates that can be hybrid 2-3 times a week in our Chicago office, but will also consider all-star remote candidates. The individual will support one of the bank's highest visibility teams/projects that is developing an industry-leading product. They are looking for a business analyst with strong technical writing experience and a passion for API documentation to join their product team. This role will be responsible for creating, maintaining, and improving the product documentation that explains how to effectively use and integrate with their APIs and other products.

Responsibilities

  • Develop and maintain comprehensive API documentation, including tutorials, guides, and reference materials.
  • Collaborate with software developers and product managers to understand API functionalities and potential uses.
  • Translate technical information into user-friendly documentation that can be easily understood by developers and end-users.
  • Ensure all API documentation is accurate, up-to-date, and reflects any changes or new features.
  • Test APIs and their documentation for accuracy and completeness.
  • Gather and incorporate user feedback to improve the documentation experience.
  • Stay informed about the latest trends in API documentation and apply best practices.

Requirements

  • 2+ years of experience owning technical writing/documentation
  • Experience working with development teams and a strong understanding of SDLC, backend language, and API concepts
  • Familiarity with ReadMe (or equivalent documentation tools)
  • Experience with Postman (or similar platforms used for creating and managing API documentation)
  • Banking industry experience
  • Bachelor's degree in Technical Writing, Computer Science, Information Technology, or a related field.

Nice-to-haves

  • Diagramming or visual representation skills
© 2024 Teal Labs, Inc
Privacy PolicyTerms of Service