Technical Writer
VLink Inc
- Central Jakarta, IndonesiaCentral Jakarta, DKI Jakarta, IndonesiaCentral JakartaDKI JakartaIndonesiaIndonesia
- ContractualCONTRACTOR
Posted 5 hours ago and deadline of application is on 26 Apr
Recruiter was hiring 5 days ago
2025-02-26T07:20:23.021904+00:002025-04-26T17:00:00+00:00Job Description
- Writing and maintaining user manuals, API documentation, FAQs, and technical guides.
- Understanding and documenting software development processes such as Agile and DevOps.
- Creating structured content using markup languages (HTML, XML, Markdown) and documentation tools.
- Reviewing and editing existing documentation for accuracy, clarity, and consistency.
- Ensuring API documentation is well-organized and easy to understand, with examples where necessary.
- Possessing basic coding knowledge (Python, JavaScript) to understand and explain technical functionality.
- Working closely with development teams to keep documentation updated with new features and changes.
Minimum Qualifications
- Minimum 3 years of experience in technical writing, specifically within the IT or software development industry.
- Demonstrated ability to create clear, structured, and well-organized documentation for technical audiences, including developers, system administrators, and end-users.
- Experience working in collaborative, cross-functional teams, ideally within technology-driven environments.
- Strong verbal and written communication skills to translate complex technical concepts into easily understandable documentation.
- Ability to work closely with developers, product managers, UX designers, QA engineers, and other stakeholders to gather requirements and clarify technical details.
- Comfortable conducting interviews, meetings, and discussions with subject matter experts to extract necessary information.
- Understanding of software development methodologies, particularly Agile (Scrum, Kanban) and DevOps practices.
- Familiarity with CI/CD pipelines, version control systems (e.g., Git), and deployment processes to document software workflows effectively.
- Ability to read and understand code snippets in programming languages such as Python or JavaScript to provide better documentation for developers.
- Awareness of software architecture, debugging tools, and common development environments.
- Proficiency in writing and formatting technical documents using markup languages such as HTML, XML, or Markdown.
- Experience with documentation platforms and tools like Confluence, ReadTheDocs, or Doxygen.
- Ability to structure documentation for ease of navigation and readability.
- Strong understanding of APIs (REST, SOAP, GraphQL) and ability to create detailed API reference guides, integration documentation, and developer tutorials.
- Experience using tools like Swagger (OpenAPI), Postman, or API Blueprint to test and document API endpoints.
- Ability to explain API authentication, request/response formats, error handling, and best practices.
- Proven experience in writing and managing User manuals, API documentation, FAQs and troubleshooting guides, Technical specifications and system architecture documentation.
- Ability to maintain version control of documentation and update content as software evolves.
Jobs Summary
- Job Level
- Entry Level / Junior, Apprentice
- Job Category
- IT and Software
- Educational Requirement
- Bachelor's degree graduate
- Office Address
- Central Jakarta, DKI Jakarta, Indonesia
Feel secure when applying: look for the verified icon and always do your research on a company. Avoid and report situations when employers require payment or work without compensation as part of their application process.
About VLink Inc
Since our founding in 2007 in US and VLink Consulting Indonesia (VCI) established in 2018, VLink is truly in a class of our own for our ability to deliver on all points important to our valued customers. We are an end-to-end global partner that provides consultative to coding services. Our delivery model, based on our global presence in North America and APAC regions, provides IT services and strategic workforce solutions. Our engineering mindset enables us to swiftly create affordable and tailored solutions for our customers – large and small.