Hi,
Hope you are doing well!
Position: Technical Writer
Location: Remote with occasional visits to office location in Eastern Philadelphia, 19341
Job Type: Open-ended consultant role, with eventual Full-time possible
Work Authorization: U.S. Citizen or Green Card
Must have strong communication.
Candidates must reside within driving distance to Exton, PA
Client is currently seeking a Consultant for a long-term Technical Writing role. This individual will be responsible for creating clear, accurate, and user-friendly technical documentation that helps users understand and use a family of software tools. Our ideal candidate will have previous experience creating technical documents, including user manuals, technical guides, API documentation, and system documentation.
Responsibilities:
- Develop a variety of technical documents, including user manuals, technical guides, API documentation, and system documentation.
- Collaborate with subject matter experts (SMEs) and technical professionals to collect and understand complex technical information.
- Organize and structure technical content in a logical and coherent manner, making it accessible to both technical and non-technical audiences.
- Transform technical jargon and complex concepts into clear, concise, and reader-friendly language, ensuring that the content is easily digestible.
- Ensure that documentation complies with industry standards, regulations, and company guidelines, particularly in regulated industries like healthcare or finance.
- Coordinate the release and distribution of documentation alongside product or software releases.
- Create training materials, tutorials, and online help systems to support end-users and internal teams.
- Develop multimedia content, such as video tutorials or interactive guides, to enhance the learning experience.
Qualifications:
Required
- A minimum of 5 years of professional experience in technical writing, with a focus on API documentation- MUST
- Previous specific experience writing technical specifications for APIs and a strong understanding of API validation.- MUST
- Proficiency in documentation tools such as Swagger (preferred), Markdown, Confluence, or equivalent- MUST
- Capability to comprehend source code in languages like Golang and PHP
- Working knowledge of code repositories and code management activities- MUST
Preferred
- Understanding of RESTful APIs, SDKs, and web technologies
- Familiarity with Agile methodologies
- Prior experience writing use cases
Job Type: Contract
Salary: $55.00 - $60.00 per hour
Schedule:
- 8 hour shift
Experience:
- API Validation: 3 years (Required)
Work Location: Remote