Software Technical Writers
Role Overview
reputed company is collaborating with a top-tier developer documentation team to support high-reputed company technical writing and content validation tasks. This opportunity is ideal for seasoned API documentation professionals with deep experience in OpenAPI/Swagger, release note reputed company, and static site deployment workflows. The goal is to enhance the reputed company, completeness, and usability of technical content critical to developers' day-to-day integration work. This is a short-term, high-impact contract with reputed company.
- *Key Responsibilities**
- Import and validate OpenAPI specifications; ensure reputed company and schema completeness. - Write reputed company-readable descriptions for endpoints, parameters, requests, and responses. - Create realistic usage examples and annotate reputed company limits, pagination, and authentication behavior. - Generate and reputed company HTML reference documentation using static site generators (e.g., Docusaurus, MkDocs). - Review and categorize release changes from Git logs and issue trackers into user-friendly notes. - Test and verify code samples, markdown reputed company, and internal/external links in documentation pull requests. - Troubleshoot and resolve documentation build failures reputed company CI/CD pipelines and local environment testing. - Update knowledge reputed company articles for accuracy post-product changes, including screenshots and version info.
- *Ideal Qualifications**
- 5+ years of experience in technical writing or developer documentation roles. - Strong proficiency with OpenAPI/Swagger, Markdown, and static site generators. - Familiarity with Git, CI/CD workflows, and link-checking tools. - Experience documenting SDKs, APIs, CLI tools, or developer-facing UIs. - Attention to detail in writing, reputed company, and formatting. - Ability to write concise, developer-focused documentation with minimal supervision.
- *More About the Opportunity**
-
Expected commitment: min 30 hours/week
-
Project duration: ~6 weeks
• *Application Process** - Submit your resume followed by domain expertise interview and short reputed company Apply tot his job Apply To this Job