API Technical Writer

3 weeks ago


Delhi, Delhi, India Akshaya IT Business solutions Full time

Job Description :

Responsibilities :

- Create and maintain comprehensive API documentation, including API reference guides, tutorials, code samples, and developer guides.

- Document RESTful APIs, GraphQL APIs, and other API types.

- Ensure documentation is accurate, up-to-date, and consistent with API changes.

- Develop and maintain API documentation using tools such as Swagger/OpenAPI, Markdown, or other documentation platforms.

- Work closely with developers, product managers, and QA engineers to gather information and ensure documentation accuracy.

- Participate in API design reviews and provide feedback on documentation requirements.

- Collaborate with developers to create code samples and examples.

- Develop and implement content strategies for API documentation.

- Plan and prioritize documentation tasks based on product release schedules and developer needs.

- Identify opportunities to improve documentation quality and usability.

- Ensure API documentation is user-friendly and accessible to developers of varying skill levels.

- Gather and incorporate developer feedback to improve documentation.

- Conduct usability testing and analyze user metrics to identify areas for improvement.

- Stay up-to-date with the latest API documentation tools and technologies.

- Utilize version control systems (e.g., Git) for documentation management.

- Develop and maintain documentation templates and style guides.

- Edit and proofread documentation for accuracy, clarity, and consistency.

- Ensure adherence to style guides and branding guidelines.

- Review and update existing documentation to reflect product changes.

Required Skills :

- Proven experience in creating and maintaining API documentation.

- Strong technical writing skills with the ability to explain complex concepts clearly and concisely.

- Understanding of RESTful APIs, GraphQL APIs, and other API technologies.

- Proficiency in using API documentation tools (Swagger/OpenAPI, Markdown, etc.).

- Experience with version control systems (Git).

- Excellent verbal and written communication skills.

- Ability to collaborate effectively with cross-functional teams.

- Strong problem-solving and analytical skills.

Required Experience :

- 5-10 years of experience as an API Technical Writer or similar role.

- Proven experience in documenting software APIs.

- Experience working in an Agile development environment.

- Experience with developer portals and knowledge bases.

Preferred Skills :

- Basic understanding of programming languages (e.g., Python, JavaScript).

- Experience with cloud platforms (AWS, Azure, GCP).

- Experience conducting usability testing and analyzing user metrics.

- Experience with content management systems.

- Knowledge of SEO best practices for technical documentation

(ref:hirist.tech)

  • Delhi, Delhi, India TekXera Full time

    About Role: A pioneering company at the forefront of AI-driven technologies is seeking a skilled API PRD Writer Specialist with expertise in API documentation, data engineering, and business analysis. The ideal candidate will define and document RESTful APIs for complex systems, ensuring clarity, structure, and adherence to best practices. This role is...


  • Delhi, Delhi, India TekXera Full time

    About Role:A pioneering company at the forefront of AI-driven technologies is seeking a skilled API PRD Writer Specialist with expertise in API documentation, data engineering, and business analysis. The ideal candidate will define and document RESTful APIs for complex systems, ensuring clarity, structure, and adherence to best practices. This role is...


  • Delhi, Delhi, India TekXera Full time

    About Role:A pioneering company at the forefront of AI-driven technologies is seeking a skilled API PRD Writer Specialist with expertise in API documentation, data engineering, and business analysis. The ideal candidate will define and document RESTful APIs for complex systems, ensuring clarity, structure, and adherence to best practices. This role is...


  • Delhi, Delhi, India TekXera Full time

    About Role:A pioneering company at the forefront of AI-driven technologies is seeking a skilled API PRD Writer Specialist with expertise in API documentation, data engineering, and business analysis. The ideal candidate will define and document RESTful APIs for complex systems, ensuring clarity, structure, and adherence to best practices. This role is...

  • Technical Writer

    2 weeks ago


    Delhi, Delhi, India OnPoint Insights Full time

    Role: Technical WriterLocation: RemoteDuration: FreelanceJob Description:We are seeking a talented Technical Writer to create clear, concise, and comprehensive documentation for our data-driven solutions. The ideal candidate will have a strong understanding of data science, data analytics, data engineering, and AI & ML concepts, and the ability to translate...


  • Delhi, Delhi, India 3C Logic Full time

    Position Name: Senior Technical Writer Experience: 7-8 years Job Type: Full Time Location: Hybrid (Delhi NCR) Position Summary: At 3CLogic, technical writers transform complex information into clear, concise, and accurate content without relying on jargon. As a Technical Writer in our Product Management division, you will be the primary content developer for...


  • Delhi, Delhi, India CyberSolve Full time

    Position Overview:We are seeking a skilled Senior Technical Writer with experience in technical documentation, specifically that has flavour of tools/products that fall under Identity and Access Management (IAM) area.Key Responsibilities:Technical Documentation Development:Create, edit, and maintain high-quality product documentation, including user guides,...


  • Delhi, Delhi, India 3C Logic Full time

    Position Name: Senior Technical Writer Experience: 7-8 years Job Type: Full Time Location: Hybrid (Delhi NCR) Position Summary: At 3CLogic, technical writers transform complex information into clear, concise, and accurate content without relying on jargon. As a Technical Writer in our Product Management division, you will be the primary content developer for...


  • Delhi, Delhi, India Talent Corner Full time

    Roles and Responsibilities   Designation- Technical Content writer You will be responsible for creating a wide range of technical documentation, including technical blogs, white papers, technical reports, and case studies, establishing us as industry experts. Desired Candidate Profile   Perks and Benefits  


  • Delhi, Delhi, India Enterprise Minds, Inc Full time

    At Enterprise Minds Inc, we are dedicated to empowering businesses through cutting-edge AI solutions. As a Senior Proposal Writer, you will play a pivotal role in crafting compelling proposals that showcase our expertise in AI and IT services.About the RoleWe are seeking an experienced Senior Proposal Writer with a proven track record of success in technical...


  • Delhi, Delhi, India API - Asia Pacific Inspection Ltd Full time

    About the RoleWe are looking for a Technical Compliance Officer to join our team at API - Asia Pacific Inspection Ltd. The successful candidate will be responsible for conducting technical onsite audits, evaluating factory processes, and ensuring compliance with established standards and procedures.Key Responsibilities

  • Technical Writer

    6 days ago


    Delhi, Delhi, India Ubique Systems Full time

    Technical WriterExperience : B2-4-7YLocation: Pan IndiaNotice Period-0-30 DAYSRequired Skillset:Good Communication SkillsKnowledge on Madcap Flare Authoring ToolKnowledge on ConfluenceKnowledge MSTP Style GuideHTML, CSS, Javascript, Jquery, Bootstrap, Video CreationResponsibilities:Collaborate with SMEs and TPOs to work on the selecting story points for the...

  • LLM API PRD Writer

    4 weeks ago


    Delhi, Delhi, India Jupiter AI Labs ✔ Full time

    Job Responsibilities:- Write clear, structured, and detailed API specifications, ensuring comprehensive endpoint documentation.- Define data schemas, business rules, and validation logic, incorporating cross-resource dependencies.- Establish error handling standards and validation rules to improve API reliability and consistency.- Collaborate with...

  • LLM API PRD Writer

    1 week ago


    Delhi, Delhi, India Jupiter AI Labs ✔ Full time

    Job Responsibilities:Write clear, structured, and detailed API specifications, ensuring comprehensive endpoint documentation.Define data schemas, business rules, and validation logic, incorporating cross-resource dependencies.Establish error handling standards and validation rules to improve API reliability and consistency.Collaborate with engineering and...

  • Technical Auditor

    1 week ago


    Delhi, Delhi, India API - Asia Pacific Inspection Ltd Full time

    About the Company Founded in 1994, API is a global provider and one of the few specialists in quality management solutions for furniture, home appliances, toys, and electronics. We partner with clients to deliver tailor-made solutions that enable their success in competitive markets. API supports the largest mass-market retailers worldwide in their sourcing...


  • Delhi, Delhi, India Serigor Inc. Full time

    Technical Proposal Writer Company: Serigor, Inc.Website : www.serigor.com Department : Presales and Solution Experience : Minimum 7 Years Type of Role : Individual Contributor Reports to : Director – Presales and Solution Location : Delhi is preferred.Remote is also fine Shift: EST Time Zone   Job Description This job is a great opportunity for people who...


  • Delhi, Delhi, India BayInfotech Full time

    We are looking for an experienced Technical Proposal Writer to manage and support our proposal writing and submission efforts. This role will be vital in the creation, management, and submission of our proposals across multiple federal agencies. This role will be instrumental in facilitating growth at BayInfotech and will have a direct impact across all...

  • Technical Auditor

    4 weeks ago


    Delhi, Delhi, India API - Asia Pacific Inspection Ltd Full time

    About the CompanyFounded in 1994, API is a global provider and one of the few specialists in quality management solutions for furniture, home appliances, toys, and electronics. We partner with clients to deliver tailor-made solutions that enable their success in competitive markets. API supports the largest mass-market retailers worldwide in their sourcing...

  • Technical Auditor

    7 days ago


    Delhi, Delhi, India API - Asia Pacific Inspection Ltd Full time

    About the Company Founded in 1994, API is a global provider and one of the few specialists in quality management solutions for furniture, home appliances, toys, and electronics. We partner with clients to deliver tailor-made solutions that enable their success in competitive markets. API supports the largest mass-market retailers worldwide in their sourcing...


  • Delhi, Delhi, India RiskProfiler Inc Full time

    This is a remote position. We are seeking a skilled Technical Content Writer with a background in cybersecurity or related fields to create high-quality, engaging, and informative content. The ideal candidate will have a solid understanding of cybersecurity technologies, industry trends, and the ability to translate technical information into clear,...