Job description
We are looking for a skilled Technical Writer or Documentation Specialist to transform our existing project into clear, well-structured documentation and user manuals. The ideal candidate will have experience in technical writing, software documentation, and the ability to simplify complex technical concepts for end-users and developers.
Responsibilities:
- Review and analyze the existing codebase to create comprehensive technical documentation, including:
- API documentation
- Developer guides
- User manuals
- Installation & setup instructions
- Troubleshooting FAQs
- Work closely with developers to ensure accuracy and completeness.
- Organize documentation into a logical, easy-to-navigate structure.
- Use tools like Markdown, Sphinx, ReadTheDocs, GitBook, or Confluence.
- Ensure consistency in style, terminology, and formatting.
- Potentially create tutorials, diagrams, or video walkthroughs.
Requirements:
- Proven experience in technical writing for software projects.
- Ability to understand code (Python, JavaScript, Java, etc.) and explain it clearly.
- Familiarity with version control (Git/GitHub/GitLab).
- Experience with documentation tools (e.g., Sphinx, MkDocs, Swagger).
- Strong attention to detail and ability to simplify complex topics.
- Bonus: Experience with diagram tools (e.g., Lucidchart, Draw.io).
Nice to Have:
- Background in software development or scripting.
- Knowledge of OpenAPI/Swagger for API docs.
- Experience with static site generators (Jekyll, Hugo).
Why Join Us?
- Opportunity to work on a meaningful project with real impact.
- Flexible remote work options.
- Collaborative team environment.
If you enjoy turning complex code into clear, user-friendly documentation, we’d love to hear from you!
How to Apply:
Send your resume, writing samples (e.g., past documentation), and a brief introduction to workwithus@buildapps.dev.
