This job has closed.

VMC Soft Technologies, Inc · 1 day ago

Technical Writer (API)

Cleveland, OH

Contract

Onsite

Senior Level

6+ years exp

VMC Soft Technologies, Inc is seeking a Technical Writer (API) for a contract role. The primary responsibility is to create and maintain API documentation, collaborating with developers and product managers to ensure accuracy and usability.

SoftwareProfessional ServicesInformation TechnologyBusiness DevelopmentProduct Management

H1B Sponsor Likely

Hiring Manager

Dhamu Nambakam

Responsibilities

Create API Documentation: Write API reference documentation, conceptual guides, tutorials, and tutorials

Document Structure: Detail API functions, parameters, data structures, authentication methods, and error messages

Maintain Content: Regularly update documentation to reflect new features, changes, and API versioning

Collaborate: Partner with developers, product managers, and engineers to understand functionality and ensure accuracy

Use Documentation Tools: Utilize tools like Swagger/OpenAPI, Postman, and Git-based systems (GitHub/GitLab) to generate or publish content

Gather Feedback: Collect feedback from internal teams and external developers to improve usability

Technical Proficiency: Strong understanding of RESTful APIs, JSON, and at least one or two programming languages

Writing Skills: Excellent, clear, and concise writing, with the ability to explain complex technical concepts simply

Experience Level: Generally 3-5+ years in technical writing, often requiring prior experience in API-specific documentation

Qualification

APIDocumentation ReviewGithub EnterpriseRESTful APIsBusiness Domain ResearchWriting SkillsCollaboration

Required

6-10 Years of experience

Digital: Application Programming Interface (API)

Collaboration

Business Domain Strategic Research and Writing

Github Enterprise

Communication

Documentation Review & Editing