Job Description

About the Company - We are seeking a skilled Technical Writer to join our team and create clear, comprehensive, and user-focused documentation for a cloud-based service deployed on Microsoft Azure using Kubernetes. The role will focus on documenting microservices architecture, APIs, and related workflows to support developers, system administrators, and end-users in understanding and utilizing the system effectively. The work also includes managing project document library, maintaining version control of artifacts, and maintaining project Wiki.

About the Role - Key Responsibilities:

• Collaborate with software engineers, architects, and product managers to gather technical details about microservices, APIs, and system workflows running on Azure Kubernetes Service (AKS).
• Write and maintain accurate, concise documentation, including API reference guides, microservices architecture overviews, deployment instructions, and operations/troubleshooting guides.
• Create diagrams, flowcharts, and other visual aids to illustrate system interactions, API endpoints, and data flows within the Kubernetes environment.
• Ensure documentation adheres to industry standards (e.g., OpenAPI specifications) and is accessible to both technical and non-technical audiences.
• Update documentation to reflect changes in microservices, API endpoints, or Azure/Kubernetes configurations as the project evolves.
• Organize content in a logical structure, leveraging tools like Markdown, Git, or content management systems for version control and publication.
• Maintain project documentation library using version control policies
• Maintain project Wiki

Qualifications - Proven experience as a technical writer, preferably documenting cloud-based systems, APIs, or microservices. Familiarity with Microsoft Azure, Kubernetes, and containerized environments; experience with Azure Kubernetes Service (AKS) is a plus. Strong understanding of RESTful APIs, JSON/YAML, and API documentation standards (e.g., Swagger/OpenAPI). Proficiency in technical writing tools (e.g., MadCap Flare, Confluence, or similar) and diagramming software (e.g., Visio, Lucidchart). Ability to translate complex technical concepts into clear, concise, and user-friendly language. Experience working with development teams in an Agile environment is preferred. Excellent attention to detail, organizational skills, and ability to manage multiple documentation tasks concurrently. Bachelor’s degree in technical writing, computer science, or a related field (or equivalent experience).

Preferred Skills - Basic scripting or coding knowledge (e.g., Python, PowerShell) to understand code snippets and test APIs. Experience with Git or other version control systems for managing documentation. Understanding of CI/CD pipelines and their integration with Azure and Kubernetes.

Pay range and compensation package - Full-time position with occasional travel to customer and supplier sites. Hybrid work model, with 3 days in office and 2 days remote each week. Collaborative and innovative team culture focused on delivering high-quality solutions.

Job Tags

Similar Jobs