Job Summary
The Technical Writer will create, organize, and maintain high-quality technical documentation using modern documentation-as-code practices. This role requires expertise in Markdown and GitHub for version control and collaboration, as well as proficiency in using Cursor and Visual Studio Code (VS Code) as integrated development environments (IDEs) for documentation workflows. The ideal candidate will work closely with engineering teams to produce clear, accurate, and up-to-date documentation that supports product development and user enablement.
Key Responsibilities
The Technical Writer will create, organize, and maintain high-quality technical documentation using modern documentation-as-code practices. This role requires expertise in Markdown and GitHub for version control and collaboration, as well as proficiency in using Cursor and Visual Studio Code (VS Code) as integrated development environments (IDEs) for documentation workflows. The ideal candidate will work closely with engineering teams to produce clear, accurate, and up-to-date documentation that supports product development and user enablement.
Key Responsibilities
- Develop and maintain technical documentation including API references, developer guides, quick start guides, and community resources using Markdown.
- Manage documentation lifecycle through GitHub, including version control, branching, pull requests, and issue tracking.
- Utilize Cursor IDE and VS Code to write, edit, and manage documentation files efficiently, leveraging AI-powered features and extensions such as GitHub Copilot.
- Implement documentation as code principles to ensure documentation is treated with the same rigor as software code.
- Collaborate with developers, and other stakeholders to gather information and incorporate feedback.
- Ensure documentation is accurate, consistent, and aligned with Cisco’s style and formatting guidelines.
- Stay current with emerging tools and best practices in technical writing and developer documentation.
- Proficiency in Markdown for writing and formatting technical content.
- Strong experience with GitHub for source control and collaboration on documentation projects.
- Familiarity with documentation as code methodologies.
- Experience using Cursor IDE, including AI-assisted content generation.
- Proficiency with Visual Studio Code (VS Code), including use of extensions like GitHub Copilot for AI-assisted writing and scripting.
- Ability to create and manage documentation files in various formats (e.g., .md, .docx).
- Excellent written communication skills with attention to detail.
- Ability to work collaboratively in an agile development environment.
Requires Markdown, GitHub, Cursor, and Visual Studio Code proficiency; documentation-as-code experience; strong technical writing, collaboration, and agile development skills.
Key Responsibilities
- creating documentation
- managing versions
- collaborating developers
Skills & Tools
Markdown, GitHub, Cursor, Visual Studio Code, GitHub Copilot
Job Details
- Category: Communications and Public Affairs
- Seniority: No Prior Experience Required
- Commitment: Full Time
- Workplace: Remote — India
- Languages: English
About Innovatia
A technology services company providing managed services and software solutions. — Industry: Information Technology