Apex Systems
API Technical Writer
Apex Systems, Cedar Rapids, Iowa, United States, 52404
If interested please send your resume to Kristin Pulkrab - [email protected]
Senior API Technical Writer
100% Remote
Job Summary: We are seeking a highly skilled and experienced Senior API Technical Writer to join a midwestern financial services client. The ideal candidate will have a strong background in OpenAPI Specification (OAS), technical writing, particularly in documenting APIs, and will be responsible for creating comprehensive and user-friendly documentation for our API products. This role requires close collaboration with developers, product managers, and other stakeholders.
Qualifications:
Experience: Minimum of 7 years of experience in technical writing, with at least 3 years focused on OAS API documentation. Required Skills:
Extensive experience with OpenAPI Specification (OAS). Familiarity with the following tools and languages:
JSON language (required) YAML language (required) Swagger/OAS development experience (OAS is written in YAML) (required) Postman (preferred) Visual Studio Code editor (preferred) Any C# language experience is very highly preferred, and any former object-oriented development experience is a plus API (OAS) cataloging tools, such as Azure Developer Portal or MuleSofts Anypoint Exchange (preferred)
Experience in a software development environment. Strong understanding of RESTful APIs and related technologies. Excellent writing, editing, and proofreading skills. Ability to understand and explain complex technical concepts clearly and concisely. Proficiency with documentation tools such as Swagger, Postman, and Markdown. Experience with version control systems like Git. Strong attention to detail and organizational skills. Ability to work independently and manage multiple projects simultaneously.
Key Responsibilities:
Develop and Maintain API Documentation: Create and update detailed API documentation, including endpoint descriptions, request/response formats, error codes, and usage examples. Collaborate with Development Teams: Work closely with developers and product managers to understand API functionality and ensure accurate documentation. Review and Edit Documentation: Ensure all documentation is clear, concise, and free of errors. Continuously improve the quality and usability of documentation based on user feedback.
EEO Employer
Apex Systems is an equal opportunity employer. We do not discriminate or allow discrimination on the basis of race, color, religion, creed, sex (including pregnancy, childbirth, breastfeeding, or related medical conditions), age, sexual orientation, gender identity, national origin, ancestry, citizenship, genetic information, registered domestic partner status, marital status, disability, status as a crime victim, protected veteran status, political affiliation, union membership, or any other characteristic protected by law. Apex will consider qualified applicants with criminal histories in a manner consistent with the requirements of applicable law. If you have visited our website in search of information on employment opportunities or to apply for a position, and you require an accommodation in using our website for a search or application, please contact our Employee Services Department at [email protected] or 844-463-6178 .
Apex Systems is a world-class IT services company that serves thousands of clients across the globe. When you join Apex, you become part of a team that values innovation, collaboration, and continuous learning. We offer quality career resources, training, certifications, development opportunities, and a comprehensive benefits package. Our commitment to excellence is reflected in many awards, including ClearlyRated's Best of Staffing in Talent Satisfaction in the United States and Great Place to Work in the United Kingdom and Mexico.
Job Summary: We are seeking a highly skilled and experienced Senior API Technical Writer to join a midwestern financial services client. The ideal candidate will have a strong background in OpenAPI Specification (OAS), technical writing, particularly in documenting APIs, and will be responsible for creating comprehensive and user-friendly documentation for our API products. This role requires close collaboration with developers, product managers, and other stakeholders.
Qualifications:
Experience: Minimum of 7 years of experience in technical writing, with at least 3 years focused on OAS API documentation. Required Skills:
Extensive experience with OpenAPI Specification (OAS). Familiarity with the following tools and languages:
JSON language (required) YAML language (required) Swagger/OAS development experience (OAS is written in YAML) (required) Postman (preferred) Visual Studio Code editor (preferred) Any C# language experience is very highly preferred, and any former object-oriented development experience is a plus API (OAS) cataloging tools, such as Azure Developer Portal or MuleSofts Anypoint Exchange (preferred)
Experience in a software development environment. Strong understanding of RESTful APIs and related technologies. Excellent writing, editing, and proofreading skills. Ability to understand and explain complex technical concepts clearly and concisely. Proficiency with documentation tools such as Swagger, Postman, and Markdown. Experience with version control systems like Git. Strong attention to detail and organizational skills. Ability to work independently and manage multiple projects simultaneously.
Key Responsibilities:
Develop and Maintain API Documentation: Create and update detailed API documentation, including endpoint descriptions, request/response formats, error codes, and usage examples. Collaborate with Development Teams: Work closely with developers and product managers to understand API functionality and ensure accurate documentation. Review and Edit Documentation: Ensure all documentation is clear, concise, and free of errors. Continuously improve the quality and usability of documentation based on user feedback.
EEO Employer
Apex Systems is an equal opportunity employer. We do not discriminate or allow discrimination on the basis of race, color, religion, creed, sex (including pregnancy, childbirth, breastfeeding, or related medical conditions), age, sexual orientation, gender identity, national origin, ancestry, citizenship, genetic information, registered domestic partner status, marital status, disability, status as a crime victim, protected veteran status, political affiliation, union membership, or any other characteristic protected by law. Apex will consider qualified applicants with criminal histories in a manner consistent with the requirements of applicable law. If you have visited our website in search of information on employment opportunities or to apply for a position, and you require an accommodation in using our website for a search or application, please contact our Employee Services Department at [email protected] or 844-463-6178 .
Apex Systems is a world-class IT services company that serves thousands of clients across the globe. When you join Apex, you become part of a team that values innovation, collaboration, and continuous learning. We offer quality career resources, training, certifications, development opportunities, and a comprehensive benefits package. Our commitment to excellence is reflected in many awards, including ClearlyRated's Best of Staffing in Talent Satisfaction in the United States and Great Place to Work in the United Kingdom and Mexico.