Job Description
The role requires creating, updating, and maintaining a wide range of technical documentation—including user guides, API references, process manuals, and functional specifications—for an IT or software product environment. You will collaborate closely with engineering, product, and quality teams, as well as customer representatives, to gather information, ensure clarity and accuracy, and support project and product development activities.
- Explain technical ideas in simple, clear language for varied audiences.
- Meet with customer representatives, engineers, product managers, and QA to gather requirements and verify content.
- Create, update, and maintain product requirement documents (PRDs), business requirements documents (BRDs), system specifications (SRS), functional specifications (FSD), user manuals, installation guides, API documentation, FAQs, release notes, and other user documentation.
- Write, edit, and proofread documentation to ensure clarity, accuracy, and consistency across styles and formats.
- Maintain style guides, documentation templates, version control (Git or SVN) and CMS platforms such as Confluence or Jira.
- Review and update existing documentation on a regular basis to reflect product changes and user feedback.
- Support process documentation and internal developer documentation, including onboarding guides and coding standards.
- Collaborate with cross‑functional teams to develop detailed business process documentation for operational modules (e.g., ticketing, membership, inventory).
- Ensure all documentation aligns with internal standards and industry best practices.
- Bachelor’s degree in Information Technology, Computer Science, Technical Communication, English, or a related field (or equivalent practical experience).
- Minimum of 1 year (mid‑level), 3+ years (mid‑level) or 5+ years (senior level) of experience as a Technical Writer in an IT/software environment.
- Proven ability to produce clear, structured, and detailed documentation such as API references, user manuals, and process guides.
- Strong written and verbal communication skills, with the ability to explain complex technical concepts to non‑technical stakeholders.
- Experience managing style guides, documentation templates, version control (Git/SVN) and CMSs (Confluence, Jira).
- Familiarity with tools such as Google Docs, Markdown, Swagger/OpenAPI and other documentation platforms.
- High attention to detail, accuracy, and organization, with a proactive approach to learning new technologies.
- Analytical skills to translate UI/UX designs into functional requirements and support agile development cycles.
- Experience collaborating with developers, product managers, and QA teams for document verification and updates.