Technical Writer

Job Description: We are seeking a highly skilled Technical Writer with a solid understanding of Helm and Kubernetes to join our team. In this role, you will play a crucial part in migrating our existing Markdown-based installation guides to our documentation portal powered by MKDocs. Your contributions will ensure our documentation is organized, user-friendly, and meets the needs of both our internal Support team and external users.

Key Responsibilities:

• Content Integration: Migrate Markdown-based installation guides (currently converted to PDF) into the existing MKDocs-powered documentation portal.
• Content Reorganization: Outline and restructure existing content to effectively address the needs of internal Support teams and external users.
• Procedure Updates: Revise and enhance installation, maintenance, and upgrade procedures to ensure accuracy and clarity.
• Environment Documentation: Create and document testing environments to validate documentation accuracy.
• Component Identification: Identify and document requisite components, systems, and dependencies.
• Procedure Testing: Test all installation procedures and include supporting visuals such as screenshots and diagrams where appropriate.
• Compliance Standards: Ensure all content aligns with any necessary compliance standards.
• Handoff Documentation: Develop a comprehensive handoff document to aid future maintenance of the documentation.

What you’ll need to succeed in this role:

• Proven experience as a Technical Writer, particularly in software or infrastructure domains.
• Strong understanding of Helm and Kubernetes.
• Proficiency in using MKDocs or similar static site generators for documentation.
• Ability to create user-centric documentation that caters to both technical and non-technical audiences.
• Experience with Markdown and related tools for content creation and migration.
• Strong organizational skills to outline and restructure large amounts of information effectively.
• Excellent written communication skills and attention to detail.
• Familiarity with compliance and technical documentation standards.
• Experience in testing and documenting technical procedures.