Technical Writer (api Documentation)

Year    Remote, IN, India

Job Description

We are hiring for Technical Writer - API Documentation

(Start Immediately or within 1 to 2 weeks)

Experience: 2+ years

Education Qualification: Bachelor's or master's Degree

Employment type:Immediate , Part Time or Full Time

Key Responsibilities:

() - Do you have a passion for explaining complex technical concepts in clear and concise language? Are you excited about the world of APIs and helping developers integrate them seamlessly? If so, then this Technical Writer - API Documentation role might be the perfect fit for you!

About the Role:

As a Technical Writer specializing in API documentation, you will be responsible for creating comprehensive and user-friendly documentation for our company's APIs. You will work closely with engineers and product managers to understand the technical details of the APIs and translate them into clear and accessible instructions for developers.

Responsibilities:

Research and analyze APIs to understand their functionalities and features.

Develop clear and concise documentation using industry best practices and standards.

Write reference guides, tutorials, code samples, and troubleshooting guides.

Maintain and update documentation as the APIs evolve.

Collaborate with engineers and product managers to ensure accuracy and completeness of documentation.

Contribute to the development of documentation style guides and templates.

Stay up-to-date on the latest trends and best practices in API documentation.

Qualifications:

Bachelor's degree in technical writing, computer science, or a related field.

Minimum 2 years of experience in writing API documentation.

Strong understanding of RESTful APIs and other common API design principles.

Excellent written and verbal communication skills.

Ability to translate complex technical concepts into clear and concise language for a non-technical audience.

Proficiency in using documentation tools like Swagger, ReadMe, or Apiary.

Experience with version control systems like Git.

Strong attention to detail and ability to meet deadlines.

Bonus Points:

Experience with programming languages like Python, Java, or JavaScript.

Experience with Markdown and other markup languages.

Knowledge of web development principles.

Interested candidates please send your resume to "hr@resolink.in"

Job Types: Full-time, Part-time, Permanent

Pay: ?200,000.00 - ?600,000.00 per year

Schedule:

• Day shift
• US shift

Application Question(s):

• Restful API
• common API design
• API Documentation

Experience:

• total work: 2 years (Preferred)

Work Location: Remote

Beware of fraud agents! do not pay money to get a job

MNCJobsIndia.com will not be responsible for any payment made to a third-party. All Terms of Use are applicable.


Related Jobs

Job Detail

  • Job Id
    JD3396978
  • Industry
    Not mentioned
  • Total Positions
    1
  • Job Type:
    Contract
  • Salary:
    Not mentioned
  • Employment Status
    Permanent
  • Job Location
    Remote, IN, India
  • Education
    Not mentioned
  • Experience
    Year