Job Details

  • Technical Writer

    Technical Writer
    16 Jan 2014
    Experience -

    Commit, a leading quality documentation service provider requires Technical Writers.\r\n \r\nJob Title: Technical Writer\r\n \r\nNo. of Positions: 2\r\n \r\nLocation: Bangalore\r\n \r\nEmployment Type: Permanent\r\n \r\nExperience: 2 - 4 years\r\n \r\nEducational Background: Graduate/Post-Graduate from any recognized University\r\n \r\nRequired Skill Sets:\r\nAs a member of the Technical Publications team, your primary responsibility will be to maintain and grow the standard set of technical publications that support API. This includes installations guides, operations guides, user guides, deployment guides, and anything else that will help API customers deploy products successfully. The audience includes engineering, operations, and professional services teams who are located in Bangalore and in the United States. Project needs often arise last minute, and processes may be created and implemented in the moment. You must be able to react quickly to changing needs, make sound decisions with limited amounts of information, and multitask. Specifically:\r\n\r\no Research documentation distributed by competitors when possible and offer opinions about where and how our documentation set can be improved.\r\no Research the audience and how best to satisfy its documentation needs.\r\no Be an advocate for Technical Publications throughout.\r\no Solicit feedback on the utility of the documents.\r\no Be able to think like a customer even after becoming familiar with products.\r\no Contribute to the entire documentation life cycle from concept through planning to development and writing. Review existing documentation and understand what new features need to be incorporated in the documentation and what features may no longer be pertinent to a new release.\r\n\r\n\r\nSpecific responsibilities:\r\n\r\n• Interview subject matter experts (product managers, developers, professional services, customer service, etc.) to create API documentation for suite of applications.\r\n• Read, understand, and edit API reference documentation (similar to Javadoc) for a Web-services-based API and composite object model.\r\n• Ability to execute REST APIs and get the JSON responses for the purpose of documentation.\r\n• Create UML class diagrams \r\n• Improve the overall quality of API reference documentation.\r\n• Read and understand sample applications that implement the APIs. Become familiar with various existing sample applications and add much-needed documentation to the samples.\r\n• Create Programming Guides, FAQs, and other publications for developers that leverage the API reference and sample applications in a coherent, meaningful way.\r\n• Provide useful, practical information to developers who are creating new (or integrating existing) applications for managing infrastructure components.\r\n• Work with the development team in a project management, writer, and reviewer capacity for the collection of new and updated technical content during the release cycle\r\n• Be able to create and manage schedules, and identify possible workarounds when there are competing demands on your time.\r\n• Execute on documentation project plans set by manager\r\n• Assist with the development of writing standards for API documentation for the Technical Publications department\r\n• Manage multiple projects and time successfully\r\n\r\nRequirements:\r\nSuccessful candidate must have 2 – 4 years of technical writing experience focused on API documents and be able to furnish samples. Also required are 1-2 years developer experience or equivalent hands-on working knowledge.\r\n\r\n• Experience creating Admin, Installation, and Ops guides for API deployments. \r\n• Excellent written, verbal, and interpersonal skills (writing samples are required)\r\n• Ability to step-through undocumented sample code, figure out what’s going on, and write about it in simple, straightforward language, from a high-level.\r\n• Ability to add comments to the undocumented sample source code (in addition to the high-level description)\r\n• Understanding of programming basics, including ability to write, compile, and run simple programs.\r\n• Be able to build sample apps/code snippets in at least one of our customer-preferred languages: PHP, Ruby, C#, Python or Java.\r\n• Basic conceptual understanding of distributed client/server computing environments, especially RESTful services and then SOAP/XML. Writer must be experienced in building developer documentation and have working knowledge of one or more of these languages: Java, C#, Ruby, PHP.\r\n• Fluency in American English\r\n• Excellent organizational skills\r\n• Ability to translate customer requests into written documents.\r\n• Ability to learn new applications, technical concepts\r\n• Self-directed and can-do attitude \r\n• Ability to multitask, prioritize, and meet aggressive deadlines\r\n• Experience presenting complex technical material to a variety of audiences\r\n\r\nWriter must have between 3 and 5 years of technical writing experience\r\nTechnical Expertise: Skilled with MS Word, Adobe Acrobat, and FrameMaker in a Windows environment\r\nHTML Knowledge\r\n\r\n \r\nCompensation: As per Industry Standards.\r\n \r\nVisit www.commit.in to know more about Commit.\r\n\r\nPlease e-mail your detailed resume to careers@commit.in\r\n

    Apply Now

Sign In




Contact Us