Blackwomenintech
API Technical Writer
Blackwomenintech, Iowa, Louisiana, United States, 70647
Job#: 2047584
Experience, qualification, and soft skills, have you got everything required to succeed in this opportunity Find out below.Job Description:
If interested please send your resume to Kristin Pulkrab - [emailprotected]Senior API Technical Writer100% 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 MuleSoft's 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.
#J-18808-Ljbffr
Experience, qualification, and soft skills, have you got everything required to succeed in this opportunity Find out below.Job Description:
If interested please send your resume to Kristin Pulkrab - [emailprotected]Senior API Technical Writer100% 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 MuleSoft's 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.
#J-18808-Ljbffr