VA Staff
Technical Documentation Specialist / Technical Writer We are looking for an experienced Technical Documentation Specialist / Technical Writer to create clear, accurate, and structured documentation for software products, APIs, systems, and technical processes. This role is ideal for someone who can understand technical concepts, work directly with developers and subject-matter experts, and translate complex systems into documentation that developers, customers, and internal teams can easily understand and use. Key Responsibilities Create and maintain technical documentation for software, APIs, systems, and development workflows. Work with developers, engineers, product teams, and other subject-matter experts to gather technical information. Review existing systems and documentation to identify gaps, outdated information, and areas requiring clarification. Turn technical specifications, developer notes, source materials, meetings, and demonstrations into structured documentation. Test documented procedures and examples whenever possible to ensure accuracy. Maintain consistent terminology, formatting, document structure, and versioning. Update documentation as products, APIs, and systems change. Types of Documentation You may be responsible for creating: API documentation REST API references API endpoint documentation Developer documentation Software documentation Product documentation System documentation Technical specifications Integration guides Implementation guides Installation and configuration guides User guides Administrator guides Troubleshooting documentation Release notes Technical SOPs Architecture and system-overview documentation Knowledge base articles Internal engineering documentation API Documentation Responsibilities For API-focused projects, you should be comfortable documenting: Endpoints HTTP methods Request parameters Request and response bodies Authentication methods Headers Status codes Error responses Pagination Rate limits Webhooks API workflows Code examples Integration procedures You should be able to understand existing API specifications and turn them into documentation that developers can use without unnecessary explanation from the engineering team. Software Documentation Responsibilities You may document: Software features and functionality Application workflows System components Configuration procedures Installation and deployment processes User roles and permissions Integrations Data flows Troubleshooting procedures Administrative processes Software updates and releases Required Qualifications Strong technical writing and editing skills. Excellent written English. Experience creating software, API, developer, or other technical documentation. Ability to understand technical concepts and explain them clearly. Strong research and information-gathering skills. Comfortable interviewing developers and technical subject-matter experts. Ability to identify missing information and ask appropriate technical questions. Strong attention to detail and documentation consistency. Ability to organize complex information into logical documentation structures. Comfortable learning unfamiliar software and technical systems. Technical Knowledge Candidates should have familiarity with several of the following: REST APIs HTTP methods JSON XML API authentication OAuth Webhooks Git/GitHub Markdown YAML OpenAPI / Swagger Postman Software development concepts Databases Cloud applications SaaS platforms Basic command-line usage You do not necessarily need to be a software developer , but you should be technically capable enough to communicate effectively with developers and understand the systems you are documenting. Documentation Tools Experience with tools such as the following is preferred: Swagger / OpenAPI Postman GitHub GitLab Confluence Notion Markdown ReadMe GitBook Docusaurus MkDocs Microsoft Word Google Docs Jira Strong Candidates Will Be Able To Given access to an API specification, software application, developer interview, existing documentation, and other source materials, you should be able to independently determine: What needs to be documented → what information is missing → who to ask → how to structure it → how to validate it → how to deliver professional documentation. We are specifically looking for someone who understands that technical documentation is not simply content writing. Sample Technical Assessment Shortlisted candidates may receive a small technical documentation exercise. For example, you may be provided with: A sample API endpoint JSON request/response data Basic developer notes A software workflow You may be asked to produce a short piece of documentation containing: Overview → Prerequisites → Authentication → Endpoint/Process → Parameters → Example → Expected Response → Errors → Troubleshooting The assessment will focus on technical comprehension, accuracy, organization, clarity, and usability . How To Apply Please provide: Resume/CV 2–3 relevant technical writing samples API documentation sample, if available Software/developer documentation sample, if available Documentation tools you have used Technologies you are familiar with Industries or software products you have documented Your availability Expected hourly or monthly rate Portfolio samples are strongly preferred. We are looking for a Technical Documentation Specialist who can take incomplete or complex technical information and transform it into accurate, structured, maintainable documentation that developers and users can actually rely on. Pay: Php30,000.00 - Php35,000.00 per month Work Location: Remote
VA Staff
