Technical documentation

Clear, up-to-date documentation gives your users the confidence to stick with your product and helps reduce the workload for your support team. It’s a win-win!

“i just want to say that I got what i needed for the problem i had from your guides. Thank you so much for making the guides useful!”

Customer @ Super.so
“Your new guides are freaking awesome btw.”

Customer @ Super.so

Clear guides → a better user experience

Remember the last time you bought a new piece of furniture, excited to set it up, only to find the instructions were a jumbled mess of confusing diagrams and vague steps? Not knowing which piece goes where will make the whole experience a headache.

Now, imagine your users feeling that same frustration with your product.

Just like you want to enjoy your new furniture quickly, your users want to get up and running with your product as fast as possible.

Clear, user-friendly documentation is the key to making that happen.

It guides users, reduces friction, showcases your commitment to their success, and gives users confidence in using your product.

Does your team relate to any of these?

Your user guides are always a step behind your latest features
Getting swamped with basic "how-to" questions
Users struggle to get your product's full potential
Losing customers due to confusion or dissatisfaction with your product
Updating documentation feels like a never-ending task
Engineers and developers just want to focus on building and improving the product

If you nodded ‘yes’ to any of these, you need a technical writer (like me!) to help up your documentation game.
Keep on reading ↓

My approach to technical documentation

As a technical writer specializing in B2B SaaS products, I understand that great documentation is an ongoing process, not a one-time fix.

Here's how I can help:

Comprehensive product understanding: I start by diving deep into your product, exploring it from a user's perspective to truly understand its functionalities and potential pain points.
Versatile documentation: From changelog updates and user guides to help center content and product update announcements, I create clear, user-friendly documentation across various platforms.
Continuous improvement: I don't just write and forget. I regularly review and update existing documentation to ensure it stays relevant to your evolving product.
User-centric approach: By analyzing user feedback and working closely with your team, I identify and address the most pressing user needs in the documentation.
UX Insights: As I work with your product, I often spot potential UX improvements, helping to enhance both the product and its documentation simultaneously.
Seamless collaboration: I integrate with your team through tools like Slack, ensuring efficient communication with developers and quick resolution of queries.

What about one-off projects?

While long-term partnerships are ideal for comprehensive documentation, I understand that sometimes you need focused, short-term help. Here's how we can approach one-off projects:

1

Rapid onboarding

Quick product overview and access to necessary resources. Brief with key stakeholders to understand urgent documentation needs.
2

Focused scope

Clearly define the specific documentation deliverables. Prioritise the most critical user needs or product features.
3

Intensive research

Accelerated product exploration and user perspective analysis. Consultation with your team for technical details and user pain points.
4

Efficient workflow

Create targeted documentation based on the agreed scope. Use templates or existing style guides for consistency.
5

Review & refine

Quick turnaround on drafts for your team's feedback. Implement revisions promptly to meet project timelines.
6

Handover

Deliver final documentation with clear instructions for integration.