$18.00 Hourly
Here’s a draft job posting tailored to your project:
Description:
We are seeking a highly skilled Technical Writer to create and revamp a knowledge base for our enterprise SaaS platform, an indoor mapping solution used in manufacturing facilities. This project involves crafting clear, concise, and user-friendly documentation tailored to a diverse user base, including frontline operators, system administrators, and managers.
If you have a proven track record of delivering high-quality software documentation and a passion for turning complex concepts into easily digestible content, we’d love to work with you!
Project Scope:
Revamp Existing Documentation:
Review and overhaul our current materials to ensure they are comprehensive and user-friendly.
Create In-Depth Guides:
Produce clear, step-by-step instructions for different user roles while keeping the tone professional yet approachable.
Quick Start Guide:
Develop a concise guide to help new users get started quickly, with screenshots and/or short video clips as needed.
Visual Enhancements:
Include annotated screenshots, diagrams, and short videos to make the documentation more engaging and easier to understand.
Knowledge Base Structure:
Organize the content into a structured format with clear navigation and search functionality, catering to multiple user roles (end-users, admins, managers).
Platform & Tools:
Hosting: The knowledge base will likely be hosted on ProductLift. Familiarity with Webflow is a significant advantage.
Collaboration: Ongoing communication via Slack.
Reference Materials: Leverage our existing materials as a starting point.
No Existing Knowledge Base: This project requires building the knowledge base from scratch.
Deliverables:
Comprehensive Knowledge Base:
User guides, troubleshooting sections, FAQs, and role-based instructions.
Professionally formatted, easy-to-navigate content.
Quick Start Guide:
Concise, step-by-step instructions for onboarding users.
Revamped Documentation:
Transform existing documentation into a cohesive, polished format.
Timeline:
We aim to deliver a strong first version of the knowledge base within 10 days.
Qualifications:
Proven experience in technical writing for software products (preferably SaaS).
Strong skills in instructional design, with the ability to simplify complex ideas.
Proficiency in creating visuals (screenshots, diagrams, videos) to enhance the documentation.
Familiarity with web-based knowledge base platforms (experience with ProductLift or Webflow is a bonus).
Exceptional communication skills and ability to collaborate effectively via Slack.
A portfolio showcasing similar projects is required.
Application Requirements:
Share examples of past knowledge base projects or similar documentation.
Include details of your experience with SaaS products and relevant tools/platforms.
Provide your proposed timeline and rate for completing this project.
We’re looking for someone who can deliver high-quality results under a tight deadline. If you have the expertise and enthusiasm to help us create an outstanding knowledge base, we’d love to hear from you!
- Germany
- Proposal: 10
- Verified
- Less than a month