Technical Writer: Legacy-to-Web System Modernization
Posted 22 days 7 hours ago by Test Triangle Limited
Dublin 1, Ireland Posted on 07/22/2025
We are seeking a highly motivated andskilled Technical Writer to play a crucial role in our legacy systemre-engineering and re-platforming project.This project involves migrating from an outdated native application to amodern web-based application.TheTechnical Writer will be responsible for creating and maintaining comprehensivedocumentation throughout the project lifecycle, ensuring clear communicationand knowledge transfer to both technical and non-technical audiences.
Responsibilities:
Document the Current State: Analyse and document the existing legacy system, including itsarchitecture, functionality, and user workflows.This will involve working closely withdevelopers and subject matter experts to understand the intricacies of thecurrent native application.
Define Future StateDocumentation: Collaborate with architects and developers to define the documentationstrategy for the new web-based application.This includes determining the types of documentation required (e.g.,user manuals, API documentation, system administration guides), the targetaudience for each document, and the overall structure and format of thedocumentation.
Develop and MaintainDocumentation: Create and maintain high-qualitytechnical documentation for the new web-based application, ensuring accuracy,clarity, and consistency.This includes:
User Manuals: Develop user-friendly guidesthat explain how to use the new web-based application, covering all featuresand functionalities.
API Documentation: Document the APIs used inthe new web-based application, providing clear explanations of endpoints,parameters, and responses.
System AdministrationGuides: Create documentation for system administrators, covering installation,configuration, maintenance, and troubleshooting of the new web-basedapplication.
Release Notes: Document changes and updatesmade to the web-based application with each release.
Collaborate with DevelopmentTeam: Work closely with the development teamthroughout the project lifecycle to ensure the documentation accuratelyreflects the evolving system.Participate in code reviews, testing, and other development activitiesto gain a deep understanding of the system.
Manage Documentation Reviewand Approval Process: Manage the review and approval process forall documentation, ensuring it meets quality standards and is approved byrelevant stakeholders.
Maintain Documentation StyleGuide: Adhere to and contribute to the maintenance of the company'sdocumentation style guide, ensuring consistency across all technicaldocumentation.
Support Knowledge Transfer: Facilitate knowledgetransfer within the team and across the organization by creating and deliveringtraining materials and presentations on the new web-based application.
Qualifications:
Proven experience as aTechnical Writer in a software development environment.
Experience documenting complextechnical systems, preferably involving legacy system modernization orre-engineering projects.
Strong understanding ofsoftware development lifecycle (SDLC) and Agile methodologies.
Excellent writing, editing, andcommunication skills, with the ability to explain technical concepts clearly toboth technical and non-technical audiences.
Proficiency in usingdocumentation tools such as Confluence, JIRA.
Experience with APIdocumentation tools such as Swagger, Postman
Ability to work independentlyand as part of a team.
Strong analytical andproblem-solving skills.
Bachelor's degree in ComputerScience, Technical Writing, or a related field.
Bonus Points:
Experience with web-basedapplication development.
Experience with Java, SpringBoot, Angular.
Experience migrating fromnative applications to web-based applications.
This job description provides acomprehensive overview of the Technical Writer's role in the legacy systemre-engineering and re-platforming project.It emphasizes the importance of documenting both the current nativeapplication and the new web-based application, ensuring a smooth transition andeffective knowledge transfer.
I've created a tailored job description fora Technical Writer specifically focused on re-engineering a legacy system andre-platforming it to a web-based application.This description emphasizes the need for experience in documenting boththe existing native application and the new web application, ensuring a smoothtransition and effective knowledge transfer.It also highlights the importance of collaboration with the developmentteam and proficiency in relevant documentation tools.