Technical Writer (API)
Technical Writer (API)
Experience: 6-10 Years
Role Summary
We are seeking an experienced Technical Writer specializing in API documentation to create clear, accurate, and developer-friendly content. This role works closely with engineering and product teams to document REST APIs, ensuring usability, consistency, and alignment with product updates.
Key Responsibilities
-
Develop API reference documentation, conceptual guides, and tutorials for developers.
-
Document endpoints, parameters, data models, authentication methods, and error handling.
-
Maintain and update documentation to reflect new features, enhancements, and version changes.
-
Collaborate with developers, product managers, and engineers to ensure technical accuracy.
-
Use tools such as Swagger , Postman , and GitHub to manage and publish documentation.
-
Gather feedback from internal stakeholders and external developers to improve clarity and usability.
-
Review and edit documentation for consistency, quality, and adherence to standards.
Required Skills & Qualifications
-
Strong understanding of RESTful APIs, JSON, and web service architectures.
-
Proficiency in API documentation standards such as OpenAPI/Swagger.
-
Experience using Git-based version control and collaboration platforms.
-
Familiarity with at least one programming language (e.g., JavaScript, Python, or Java).
-
Excellent written and verbal communication skills with strong attention to detail.
-
Ability to translate complex technical concepts into clear, user-friendly content.
Preferred Experience
-
Experience documenting enterprise or public-facing APIs.
-
Exposure to developer portals and documentation automation tools.
Recommended Jobs
Physical Therapist / PT - PRN
PRN PT Opportunity in Springboro, OH! Join a Passionate Rehab Team at Hillspring in Springboro OH - Springboro, OH Continuum Midwest is excited to offer a PRN opportunity for a licensed Ph…
Systems Test Staff Engineer
Job Description Summary The Advanced Programs Systems Engineering and Flight Test team is responsible for the design, development, vehicle integration, and testing of military and derivative comme…
Underground Equipment Operator
Operates and maintains assorted underground construction equipment and vehicles in the transportation, placement, maintenance, support and removal of assorted communication cable facilities. Knowl…
People Consulting-Organization Design-Senior-Consulting
Location: Atlanta, Austin, Boston, Chicago, Cleveland, Dallas, Denver, EY-Pitts, Hoboken, Houston, Irvine - Von Karman, Los Angeles, McLean, Metropark, Minneapolis, New York, North Carolina - Charlot…
Assistant Professor of Political Science
Assistant Professor of Political Science The Department of Political Science and Criminal Justice at Muskingum University invites applications for a full-time Assistant Professor of Political Science…
Store Manager - Toledo, OH
Rainbow USA is recognized as one of the fastest growing junior, kids, plus, and petite, specialty apparel retail chains and has grown to over 1,000 retail stores! We have multiple retail lines that p…
Travel Nurse - Psychiatric Job in Dayton, OH - $11,613 per Month (2 Years Experience Needed)
Vetted is seeking a RN - Psychiatric for a travel job in Dayton, Ohio . Must have 2+ years of experience. This contract pays approximately $11,613/month gross. Assignment details: Cont…
Sr. Mechanical Project Manager - Data Center
Sr. Mechanical Project Manager - Data Center About Us: Highland Consulting Group is a national executive search firm specializing in recruiting top-tier construction talent. With over 75 years …
Assistant General Manager
Overview: The purpose of the Assistant General Manager role is to relieve a high potential Operations Manager from their day-to-day responsibilities so they can dedicate their time to shadowing and …