Senior Technical Writer
We are seeking a highly motivated and skilled professional to play a crucial role in our legacy system re-engineering and re-platforming project. This project involves migrating from an outdated native application to a modern web-based application.
The successful candidate will be responsible for creating and maintaining comprehensive documentation throughout the project lifecycle, ensuring clear communication and knowledge transfer to both technical and non-technical audiences.
Responsibilities:
* Document the Current State:
* Analyze and document the existing legacy system, including its architecture, functionality, and user workflows.
* This will involve working closely with developers and subject matter experts to understand the intricacies of the current native application.
* Define Future State Documentation:
* Collaborate with architects and developers to define the documentation strategy for the new web-based application.
* This includes determining the types of documentation required (e.g., user manuals, API documentation, system administration guides), the target audience for each document, and the overall structure and format of the documentation.
* Develop and Maintain Documentation:
* Create and maintain high-quality technical documentation for the new web-based application, ensuring accuracy, clarity, and consistency.
* User Manuals:
* Develop user-friendly guides that explain how to use the new web-based application, covering all features and functionalities.
* API Documentation:
* Document the APIs used in the new web-based application, providing clear explanations of endpoints, parameters, and responses.
* System Administration Guides:
* Create documentation for system administrators, covering installation, configuration, maintenance, and troubleshooting of the new web-based application.
* Release Notes:
* Document changes and updates made to the web-based application with each release.
* Collaborate with Development Team:
* Work closely with the development team throughout the project lifecycle to ensure the documentation accurately reflects the evolving system.
* Participate in code reviews, testing, and other development activities to gain a deep understanding of the system.
* Manage Documentation Review and Approval Process:
* Manage the review and approval process for all documentation, ensuring it meets quality standards and is approved by relevant stakeholders.
* Maintain Documentation Style Guide:
* Adhere to and contribute to the maintenance of the company's documentation style guide, ensuring consistency across all technical documentation.
* Support Knowledge Transfer:
* Facilitate knowledge transfer within the team and across the organization by creating and delivering training materials and presentations on the new web-based application.
* Qualifications:
* Significant years of proven experience as a Technical Writer in a software development environment.
* Experience documenting complex technical systems, preferably involving legacy system modernization or re-engineering projects.
* Strong understanding of software development lifecycle (SDLC) and Agile methodologies.
* Excellent writing, editing, and communication skills, with the ability to explain technical concepts clearly to both technical and non-technical audiences.
* Proficiency in using documentation tools such as Confluence, JIRA.
* Experience with API documentation tools such as Swagger, Postman.
* Ability to work independently and as part of a team.
* Strong analytical and problem-solving skills.
* Bachelor's degree in Computer Science, Technical Writing, or a related field.
Benefits:
* Competitive base salary (annually reviewed)
* Hybrid working model (up to 2 days working at home per week)
Others:
* Equal opportunity employer