Job Description
Technical Writer with strong understanding of what it takes to build an API community and developers Network. Individual should easily be able to read code and API contracts while summarizing for easy consumption by a developer audience.
Responsibilities
• Write API documentation for API users, such as API reference docs and developer guides. Keep emphasis on documentation that is technically accurate and brings clarity for even complex processes.
• Review documents written by developers / PMs for a particular API and suggest changes / seek clarity to externalize the same documents.
• Supplement developer documentation with relevant sample code to reduce grounds-up efforts of external developers.
• Develop and use all types of content types (workflows / process schematics / instructional videos / developer consoles) to simplify the user's understanding of the Open API's.
• Be the first to respond to developer queries on API forums and put effort to resolve the issue yourself, without needing to check with the core development organization.
• Publish content that is accessible, accurate, useful and adheres to our style guide and conventions.
• Ensure documentation remains current with release updates.
Job Requirements:
• Knowledge of tools such as Jekyll, Wordpress, Adobe Framemaker, Oxygen XML author, Lucid Chart, Visio is a must.
• Experience using Git to manage asynchronous collaboration across large teams
• Experience with authoring documentation in Markdown is core.
• Familiarity with API documentation tools such as Swagger
• Knowledge of REST APIs is a must.
• Experience with programming to enable sample code will require experience, especially around core web technologies such as Python / Javascript / JSON / HTML required. Knowledge of data analytics and big data technologies is a plus.
• Demonstrate experience in writing and proofreading of content, especially technology related content.
Education:
• Master's/Bachelor's degree in any discipline, preferably I.T./Computer Science/Software Engineering or a related area is preferred- BCA/ MCA, B.Tech, B.Sc. / M.Sc. - IT
Responsibilities
• Write API documentation for API users, such as API reference docs and developer guides. Keep emphasis on documentation that is technically accurate and brings clarity for even complex processes.
• Review documents written by developers / PMs for a particular API and suggest changes / seek clarity to externalize the same documents.
• Supplement developer documentation with relevant sample code to reduce grounds-up efforts of external developers.
• Develop and use all types of content types (workflows / process schematics / instructional videos / developer consoles) to simplify the user's understanding of the Open API's.
• Be the first to respond to developer queries on API forums and put effort to resolve the issue yourself, without needing to check with the core development organization.
• Publish content that is accessible, accurate, useful and adheres to our style guide and conventions.
• Ensure documentation remains current with release updates.
Job Requirements:
• Knowledge of tools such as Jekyll, Wordpress, Adobe Framemaker, Oxygen XML author, Lucid Chart, Visio is a must.
• Experience using Git to manage asynchronous collaboration across large teams
• Experience with authoring documentation in Markdown is core.
• Familiarity with API documentation tools such as Swagger
• Knowledge of REST APIs is a must.
• Experience with programming to enable sample code will require experience, especially around core web technologies such as Python / Javascript / JSON / HTML required. Knowledge of data analytics and big data technologies is a plus.
• Demonstrate experience in writing and proofreading of content, especially technology related content.
Education:
• Master's/Bachelor's degree in any discipline, preferably I.T./Computer Science/Software Engineering or a related area is preferred- BCA/ MCA, B.Tech, B.Sc. / M.Sc. - IT
💡 Quick Summary
Seeking a career-building opportunity? The Technical Writer API | Delsat Infotech Pvt Ltd position is now open for candidates interested in the Content Writer Jobs sector. This role in Kolkata offers a professional environment and growth potential.
Requirement Snapshot: Candidates should possess basic communication skills, a proactive attitude, and the ability to work in a team. Experience in Content Writer Jobs is a plus.
