Software Documentation Specialist

At Devopsbay, we're looking for a skilled Technical Writer to migrate our existing installation guides from Markdown to MKDocs. As a key member of our team, you'll play a crucial role in ensuring our documentation is organized, user-friendly, and meets the needs of both internal Support teams and external users.

• Content Integration: Seamlessly integrate Markdown-based installation guides into our MKDocs-powered documentation portal, preserving accuracy and clarity.
• Content Reorganization: Strategically restructure existing content to effectively address the needs of internal Support teams and external users, enhancing overall user experience.
• Procedure Updates: Revise and enhance installation, maintenance, and upgrade procedures to guarantee accuracy and clarity, leveraging your expertise in software or infrastructure domains.
• Environment Documentation: Create comprehensive documentation for testing environments to validate documentation accuracy, including supporting visuals such as screenshots and diagrams where necessary.
• Component Identification: Identify and document requisite components, systems, and dependencies, ensuring seamless integration with our documentation portal.
• Procedure Testing: Thoroughly test all installation procedures, incorporating supportive visuals to ensure accuracy and clarity.
• Compliance Standards: Ensure all content aligns with relevant compliance standards, maintaining the highest level of quality and precision.
• Handoff Documentation: Develop an exhaustive handoff document to facilitate future maintenance of the documentation, streamlining the process and ensuring continuity.

To succeed in this role, you'll need:

• Proven experience as a Technical Writer, particularly in software or infrastructure domains.
• A strong understanding of Helm and Kubernetes.
• Proficiency in using MKDocs or similar static site generators for documentation.
• The 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.