The client has its own solution for landlords and their tenants that is already functioning. The solution consists of a web platform and iOS/Android applications. By using these apps, tenants can send a wide range of requests to their landlords for household services, like electricians or plumbers.
To succeed in this role you should have a natural analytical way of thinking, technical background and proven skills in writing documentation.
Documentation is a crucial part of any product development. It ensures that project requirements are fulfilled and establishes traceability with respect to what has been done, who has done it and when it was done.
As a technical writer you will be preparing a set of documents for two parties: 1) Development team, 2) End Users:
- Set up technical documentation for existing and developing products from scratch
- Communicate with development teams and stakeholders to identify information needs
- Keep track of ongoing products development and keep the documentation up-to-date
- Write API reference docs, architecture designs and diagrams etc.
- Address the gaps in cross-teams products knowledge
- Participate in requirements research and document new features and epics
- Quickly grasp complex technical concepts and make them easily understandable in text and pictures
- Document existing and new functionality by working with POs and Stakeholders throughout the development lifecycle, using development artifacts (User Stories, UML Use Cases and Activity Diagrams), and interviewing SMEs
- Create detailed user documentation for use within the application such as operating instructions and User Guides
- Ownership of product documentation, suggesting improvements and areas for expansion
- Gather feedback on deliverables as revise as new issues arise
- Review all customer-facing documentation to ensure it meets expected style and standards
- Curate and manage the internal technical Wiki, advising teams on usage and content management.