Skill diminta
AccurateAttention to DetailCommunicationPostmanSQLSwaggerTime Management
Deskripsi
What You’ll Do
Create, maintain, and update technical documentation, including Functional Specification Document (FSD), API Documentation, Technical Specification, System Flow, System Documentation, and User Guide.
Collaborate closely with Product Managers, Business Analysts, Developers, QA Engineers, and other stakeholders to understand business and system requirements.
Translate business and functional requirements into clear, structured, and easy-to-understand technical documentation.
Develop and maintain API documentation covering endpoint, request/response structure, parameters, data types, objects, lists, and related technical information.
- Understand and document system flows, integrations, dependencies, and business processes.
- Ensure documentation remains accurate, up to date, and aligned with the latest product/system releases.
- Maintain proper documentation version control and ensure changes are synchronized with the software development lifecycle.
- Review existing documentation to identify inconsistencies, missing information, or outdated content.
- Establish and maintain documentation standards, templates, and style guidelines across projects.
- Proactively gather information from relevant stakeholders and technical teams to ensure documentation accuracy and completeness.
- Contribute ideas and improvements to make the documentation process more efficient, standardized, and scalable.
- Experience & Background
Minimum 1–3 years of experience as a Business Analyst, Technical Writer, System Analyst, or similar rolewithin technology, software development, IT consulting, or digital product environments.
- Hands-on experience creating and managing FSD, API Documentation, System Documentation, or Technical Specification documents.
- Experience working closely with Product, Engineering/Development, QA, and Business teams.
- Technical Skills
- Good understanding of API concepts, particularly REST/JSON and/or SOAP.
- Able to understand API request & response structures, parameters, data types, objects, arrays/lists, and nested structures.
- Basic understanding of database concepts and schema, including Primary Key (PK), Foreign Key (FK), relationships, and data structures.
- Familiar with API documentation and testing tools such as Postman, Swagger/OpenAPI, Redoc, or similar tools.
- Good understanding of Software Development Life Cycle (SDLC).
- Familiar with Agile/Scrum methodologies and software development processes.
- Basic SQL/query knowledge for data verification and validation is a plus.
- Able to read and understand technical information, system architecture, API specifications, and system flows.
- Documentation Skills
- Strong ability to create clear, structured, consistent, and professional IT documentation.
Able to communicate technical information effectively to both technical audiences such as Developers, QA, and Engineers, as well as non-technical stakeholders such as Product, Business, and Clients.
- Familiar with documentation templates, standards, and style guides.
- Strong attention to detail in maintaining terminology, formatting, structure, and documentation consistency.
- Soft Skills
- Strong analytical and problem-solving skills with excellent attention to detail.
- Good communication and interpersonal skills.
- Comfortable working cross-functionally with Product Manager, Business Analyst, Developer, QA, and other stakeholders.
- Strong time management and ability to manage multiple documentation tasks according to deadlines.
- Proactive in asking questions, gathering information, and validating requirements.
- Able to work independently while also collaborating effectively within a team.
- Adaptable to changing requirements and fast-paced project environments.