Technical Author

About Brickreach

We make a web-based inventory and purchasing system used by independent restaurants, breweries and small food manufacturers. Most engineers work remotely and come into the office one week a quarter for planning.

The role

This is a backfill for a team member who moved to another team. This role works closely with engineers and product managers. You'll test features yourself before documenting them. Fully remote. You can work from anywhere in India.

Day to day

• Produce release notes for each product release.
• Manage content in Confluence, Zendesk Guide or MadCap Flare.
• Document REST APIs from OpenAPI specs and verify examples against a test environment.
• Edit documentation written by engineers for clarity and consistency.
• Write and update user guides, how-to articles and admin documentation.
• Review analytics and search queries to find gaps in the docs.
• Build and maintain a style guide and templates.

What you bring

• 3+ years of technical writing experience in software, hardware or a regulated industry.
• Familiarity with REST APIs, JSON and tools like Postman or curl.
• Comfortable chasing busy engineers for answers.
• Ability to read basic code in Python, JavaScript or Java.
• Strong grasp of grammar, structure and plain-language writing.
• Hands-on use of a help authoring tool or CMS.

Preferred qualifications

• Information architecture or UX writing.
• Knowledge of the Microsoft Writing Style Guide or Google developer documentation style guide.
• Setting up a docs site from scratch.

Pay and benefits

• Flexible hours.

We review applications as they come in.

Duration: 12 months. Start: Immediately.

Demo job created on 11jobs for testing and demonstrations. It is not an actual opening at Brickreach.