Job description for Technical Writer at Solutionlabs Grup Indonesia
Requirements :
- Memiliki kemampuan technical writing yang kuat dan mampu menjelaskan konsep teknis dengan jelas.
- Berpengalaman membuat dan memelihara API Documentation, termasuk endpoint, request/response, authentication, parameter, dan error codes.
- Berpengalaman membuat dan mengelola Postman Collections, termasuk environment, variables, examples, dan request folders.
- Mampu membuat Technical Specification Document (TSD) dengan system flow dan detail teknis yang jelas.
- Mampu membuat dan memelihara Use Case Diagram serta ERD/database relation scheme.
- Memahami dasar REST API, HTTP methods/status codes, JSON, SQL, relational database, dan system integration.
- Familiar dengan Swagger/OpenAPI, Postman, Markdown, Confluence, atau tools dokumentasi serupa.
- Memahami dasar Git/version control menjadi nilai tambah.
Detail-oriented, terorganisir, dan mampu menjaga dokumentasi serta versioning secara konsisten.
- Mampu berkolaborasi dengan Software Engineer, QA, Product Manager, DevOps, dan stakeholder lainnya.
Job Description :
- Membuat, memperbarui, dan memelihara API documentation untuk internal maupun external API.
- Membuat dan mengelola standardized Postman Collections, termasuk requests, examples, variables, dan environments.
- Menyusun Technical Specification Document (TSD) untuk aplikasi, module, enhancement, dan integration.
- Membuat dan memelihara Use Case Diagram untuk menggambarkan actor, system interaction, dan functional flow.
- Membuat dan memelihara ERD/database relation scheme untuk mendokumentasikan struktur dan relasi database.
- Berkolaborasi dengan Backend Engineer dan tim teknis untuk memastikan endpoint, payload, business rules, dan integration flow terdokumentasi dengan akurat.
- Memastikan dokumentasi diperbarui setiap terdapat perubahan pada API, database, architecture, atau application.
- Menjaga standar template, naming convention, version history, dan organisasi dokumentasi.
- Mereview dan meningkatkan kelengkapan, readability, serta accuracy dokumentasi teknis.
- Mendukung QA, Product, Operations, dan tim lainnya melalui technical reference untuk implementation, testing, troubleshooting, dan handover.
