Technical Writer

Job summary

The role involves documenting an existing technology and data framework, including its architecture, components, and integration patterns. The writer will collaborate with architects and engineers to create developer-friendly guides and technical illustrations.

Job details

Role Overview We are seeking an experienced Technical Writer with a strong technical background . The successful candidate will document an existing technology and data framework, including its architecture, components, capabilities, implementation patterns, and guidelines for how development and data teams can consume and integrate with the framework. This role requires someone who can work closely with architects, developers, data engineers, and business stakeholders to understand complex technical solutions and translate them into clear, structured, and developer-friendly documentation. Key Responsibilities Understand the current-state framework, its architecture, components, data flows, dependencies, and integration patterns. Create comprehensive technical documentation covering: Framework architecture and key components Framework capabilities and supported use cases How applications and data teams can consume and integrate with the framework Configuration and implementation guidelines Data flows and processing patterns Developer onboarding and getting-started guides Technical workflows and operational procedures Best practices, standards, and reusable implementation patterns Troubleshooting and FAQs Work with Solution Architects, Data Architects, Developers, Data Engineers, and SMEs to gather technical information and validate documentation. Translate complex technical concepts into documentation suitable for both technical and semi-technical audiences. Create architecture diagrams, data-flow diagrams, process flows, and other supporting technical illustrations where required. Establish consistent documentation standards, templates, terminology, and version-control practices. Maintain documentation as the framework evolves and ensure documentation remains aligned with the implemented solution. Required Skills & Experience Proven experience as a Technical Writer, preferably documenting enterprise technology, data platforms, frameworks, APIs, or developer platforms. Strong technical background with the ability to understand application and data architectures. Good understanding of Data Warehousing concepts, including dimensional/data modeling, ETL/ELT processes, data pipelines, and data integration. Experience documenting technical frameworks and explaining how other teams can consume, configure, integrate, and extend them. Ability to independently interact with technical SMEs and extract the information required to build complete documentation. Strong written communication skills with the ability to simplify complex technical concepts without losing technical accuracy. Preferred / Nice-to-Have Skills Knowledge or hands-on exposure to Databricks. Understanding of Medallion Architecture, including Bronze, Silver, and Gold data layers. Familiarity with modern data platforms, lakehouse architectures, cloud-based data engineering, and data pipelines. Understanding of APIs, integration patterns, CI/CD, Git/version control, and software development practices. Familiarity with documentation platforms and tools such as Confluence, Markdown, Git-based documentation, SharePoint, or similar tools. Experience creating technical architecture and data-flow diagrams using tools such as Visio, Lucidchart, Draw.io, or equivalent. Key Profile: Technical Writer + Data Warehousing, with Databricks and Medallion Architecture as strong advantages.

What you’ll do

The role involves documenting an existing technology and data framework, including its architecture, components, and integration patterns. The writer will collaborate with architects and engineers to create developer-friendly guides and technical illustrations.

Requirements

Candidates need proven experience in technical writing for enterprise data platforms and a strong understanding of data warehousing concepts. Proficiency with Databricks and Medallion Architecture is highly preferred.

Listed skills

• Git · Preferred
• Stakeholder Management · Preferred

Other relevant skills

Identified from the job description. Confirm important requirements above.

• Technical Writing
• Data Warehousing
• Databricks
• Medallion Architecture
• API Documentation
• ETL/ELT Processes
• Data Modeling
• Architecture Diagramming
• Confluence
• Markdown
• Git
• Cloud Data Engineering
• Technical Workflows
• Stakeholder Management
• Developer Onboarding
• Data Pipelines

Job areas

• Data & Analytics
• Technology
• Software
• Engineering
• Consulting