1 job found
- Our development team seeks a diligent, detail-oriented freelance technical writer who can produce comprehensive and easily understandable documentation for our cloud-based platform in Jersey City, NJ. We're not just looking for someone who can write; we need a candidate with a natural ability to translate complex code into human-friendly language, turning sophisticated backend processes into straightforward instruction manuals, API references, and troubleshooting guides. **Responsibilities:** * Craft clear, concise, and accurate technical documentation for our platform's features, functionalities, and updates. * Collaborate closely with engineers, product managers, and support staff to gather information and clarify technical details. * Create comprehensive API documentation with code samples, request/response schemas, and authentication procedures. * Develop step-by-step user guides and tutorials tailored to a diverse audience of technical skill levels. * Produce internal documentation, including design specifications, software architecture, and code comments. * Maintain documentation repositories to keep documentation up to date and reflect the latest code changes and releases. * Edit and revise documentation based on user feedback, code updates, and technical advancements. * Contribute to the establishment of documentation standards and style guidelines to ensure consistent and high-quality outputs. * Generate sample applications and scripts to guide developers and system integrators in effectively utilizing our platform. * Create diagrams, flowcharts, and illustrations to aid in conveying complex information in an easily digestible manner. **What makes a successful candidate?** * Proven industry background in technical writing, specifically with cloud platforms or SaaS companies. * Practical mastery of documentation tools, such as Swagger, Confluence, ReadMe.io, or similar platforms. * Strong grasp of software development principles, REST APIs, cloud computing concepts, and related technologies. * Ability to comprehend complex systems and translate them into accurate, intuitive, and user-friendly documentation. * Excellent written and verbal communication capabilities, with impeccable grammar, punctuation, and attention to detail. * Capability to work independently, manage multiple documentation projects simultaneously, and meet established deadlines. * Expertise in collaborating with engineering and product teams, navigating technical conversations, and translating jargon into clear explanations. * A track record of continually improving technical writing processes and workflows, optimizing efficiency, and enhancing documentation quality. * Understanding of SEO principles related to technical documentation, maximizing search discoverability and user engagement. * A proactive approach to researching new technologies, seeking out relevant details, and updating existing documentation. **Perks of Working with Us** As a freelance technical writer for our Jersey City-based team, you'll have access to competitive rates, flexible hours, and remote work options. Our compensation recognizes the value of your skill cultivation, offering rates tailored to your specific proficiencies. You'll also collaborate directly with senior developers, participate in sprint planning sessions, and attend company workshops aimed at refining your industry background and knowledge.Jersey City, NJRemoteFreelance$45-$65 per hourTechnical Writing & Content Marketing29 days ago