The Technical Writer- IT- Software Development is responsible for documenting software specifications, architecture, integrations, and configurations on an ongoing basis.
The successful candidate will understand how to write comprehensive, consistent, and clear content that meets the needs of the technical audience.
Develops and maintains a collaborative knowledge base of reference materials. The successful candidate will understand how to scope and elicit technical information, working closely with the software delivery team to understand and then translate the information to a living knowledge base.
KEY DUTIES & RESPONSIBILITIES
Responsible for documenting software specifications, software architecture (e.g. C4 Model), components and subsystems, integrations, configurations, setup and runtime requirements, dependencies, changes and releases.
Defines and improves processes for how and when documentation is created, updated, and organized.
Maintains documentation and ensures content / information is up-to-date, versioned, organized, linked, in an easily accessible knowledge base.
Elicit Technical Information
Communicates and collaborates with software designers, team leads, architects, and developers to understand technical product specifications.
KNOWLEDGE & SKILLS
Minimum of 3 years of professional experience in Technical Writing, and documentation version control.
Certificate or degree in Technical Writing or a relevant field e.g. English, Communications.
Professional experience in working with distributed, dynamic, agile software engineering teams.
Experience in documenting complex enterprise Web Applications, Mobile Applications, Integrations, and BI.
Firm understanding of the software development life cycle (SDLC) and working experience with software delivery artifacts.
Strong ability to understand and compose highly technical information into clear consistent material.
Working understanding of the fundamentals of programming, database, web, API concepts, infrastructure, source version control (e.g. TFS, Azure DevOps).
Proficient in creating diagrams and documenting software architecture (e.g. C4 Model), process flows, data flows, ETL, and more.
Strong working knowledge of tools, formats, and portals e.g. Confluence, Structurizr, Swagger, Markdown and YAML.
Fluent in Microsoft suite of tools including Visio and MS office Suite.
Strong communication and writing skills.
Strong attention to detail.
Proven ability to handle multiple projects simultaneously, with an eye for prioritization.