Technical Writer

About This Role

The Technical Writer will prepare high-quality documentation for the SDI & City of Chicago CDPH team, working with cross-functional teams. This role involves developing clear, concise, and structured content for technical and non-technical users, translating complex technical concepts into user-friendly material.

Responsibilities

• Create, edit, and maintain high-quality technical documentation, including user guides, data flow diagrams, ETL implementation documentation, system architecture overviews, and standard operating procedures (SOPs)
• Develop content accessible to various audiences, from technical professionals to end-users
• Ensure documentation is up to date with system changes, new features, and evolving business needs, maintaining version control
• Conduct research and interviews to gather technical details from data scientists, IT engineers, project managers, and other stakeholders
• Translate complex technical jargon into clear, understandable language for diverse audiences
• Implement structured writing techniques to maintain consistency and readability
• Format content using industry-standard templates, style guides, and publishing tools
• Utilize diagrams, flowcharts, and visual aids to enhance comprehension
• Maintain version control and ensure proper documentation workflows align with system updates and organizational changes
• Utilize documentation management tools such as Git, SharePoint, or OneDrive for collaboration and archiving
• Track feedback from users and stakeholders, implementing improvements in documentation over time
• Work closely with data scientists, IT engineers, project managers, and other stakeholders to gather requirements and validate documentation accuracy
• Participate in project meetings to stay informed of changes that require documentation updates

Requirements

• Strong understanding of data ETL processes
• Strong understanding of software development
• Strong understanding of APIs
• Strong understanding of IT infrastructure
• Strong understanding of cloud computing
• Excellent writing and communication skills
• Technical writing skills
• Microsoft Office proficiency

Skills

* Required skills

Benefits