info@samuraiapi.comTechnical Communication
with Applied Empathy
We help you build a trusting relationship with your prospects
and clients by producing good technical documentation.
Technical Communication
What we do
Develop high-quality documentation for you
Clear and well-structured documentation are what both curious beginners and active users need. We deliver documentation in a wide variety of forms: APIs, User's guides, Knowledge bases, instruction and onboarding tutorials, online Help, How-To, FAQ, Release Notes, and more.
Create developer portals and landing pages
The outstanding developer portal or landing page adds value to your corporate identity and brand. Our web developers apply the best solutions to create award-winning developer portals targeted to your audience and aligned with your business needs.
Report issues and suggest UI/UX improvements
To better understand your product, we execute E2E testing scenarios and provide feedback on the UI/UX elements, unexpected errors, and overall customer experience. Based on testing results, we update your technical documentation to move away from the user failure toward positive feelings.
How do we benefit your company?
We produce clear and accessible documentation to help your business to
Provide exceptional user experience.
Enable sales and boost company’s success.
Reduce costs for onboarding and customer support.
Communicate complex topics as humans, not robots.
How we do
Plan
Define purpose, audience, delivery channels, and deadline.
Research & Test
Interview SMEs, review existing documentation, use and test the software.
Write
Get it on paper with the docs-as-code approach or traditional writing tooling.
Review & Edit
Cooperate with colleagues to help with review. Usability testing is key.
Launch
Coordinate with the team to release at the same time as the software.
Our Principles
Created with Empathy
Technical documentation crafted for your users by skilled, empathetic technical writers is one of the most effective tools to foster a real, human connection and user engagement. This is the greatest value brought by applied empathy.
Relied on Fundamentals
SamuraiAPI has the fundamental skillset for creating successful technical communication: the ability to understand the subject, the ability to write clear and action-oriented content, and the ability to deliver it on time.
Inspired by Technologies
How software is provided and sold is changing: growth in APIs, Software as a Service, and more is significant. To support these changes, we apply the latest technologies & tools to deliver, create and manage that content.
Case Studies
Creating a developer documentation portal for a fast-growing European financial startup
A cloud-based middleware company connecting large enterprises to the global payments ecosystem required a developer documentation portal that provided API documentation, product overview, quick start guide, case studies, onboarding information, and general concepts overview.
They had provided some documentation contained in several PDFs, intranet pages, and other formats that were hard to read and follow. I created an information design model of the revised content and a complete set of redrafted and consolidated content.
The amount of content has been significantly reduced, so the information was delivered in a clear, easy-to-understand, and accessible way. The content was organized in a way that follows the customer journey.
Improving developer portal and developing documentation set for one of the largest enterprise software companies
The leader in business applications providing IT solutions in the cloud, analytics, and mobile required documentation support for two major projects as well as some enhancements to the projects’ documentation pages to simplify the process of navigation and learning through practicing.
I reviewed and updated the existing content, identified the missing content, and developed a range of technical, training, and troubleshooting content to meet the audience’s needs:
- User Guide - builds a deep understanding of the underlying technology.
- Cookbook - proposes step-by-step instructions on how to migrate an app.
- Tutorials - converts a reader from a curious investigator to an active user.
- FAQ pages - provide answers to individual questions that users ask.
The project involved working with their UX/UI team, engineers, product managers, and technical staff. Both products’ release was very successful, with positive feedback from the client.
Creating API and other documentation for a well-known international RPA company
A leading RPA company providing complex intelligent automation solutions for the digital transformation of information-intensive business workflows required a review, update, and further development of technical documentation to help new users get started smoothly and existing customers get most of the product.
I developed a number of easy-to-follow, concise, and well-structured technical documentation items, such as Online help and Developer’s guides, and improved the logical structure of the API guide. The content in this guide was organized in a way that followed the user journey:
- What are APIs and the benefits of using it?
- Get the subscription key to start using API.
- Understand the endpoints and code samples.
- Try out the API sandbox.
- Start using APIs in production.
Developing and maintaining KB articles and tutorials for leading global tobacco and vaping companies
The company required development and keeping in the up-to-date state the set of clear and effective technical documentation that provided information on how to solve customers’ problems, reduce number of requests to IT support, and provide a better onboarding experience for new employees. As a result, the number of documentation items was created:
- KB article - features a set of information about a product to solve common problems and provide instruction for resolving a particular issue.
- Tutorial - explains how to accomplish a specific task. For example, get access to a system or submit a change request.
Who we are
- With more than 15 years in IT along with academic background, we focus on content development over the development process.
- We are flexible about how we work and the tools we use to reach a specific outcome and deliver high-standard documentation for you.
- We develop and implement engaging content using DITA and DITA-based tools or innovative tooling, such as docs-as-code (Markdown, Git), design thinking, onboarding approach, etc.
- To know your product better and ensure its consistent update, we execute E2E testing scenarios and perform various documentation operations, including CI/CD.
- At SamuraiAPI, we believe simpler is better and create every document with applied empathy for you and your customers.
Tell me more about SamuraiAPI and how good technical documentation can benefit my company!
Contact Us
Send us an email at info@samuraiapi.com or fill in the form below to get best-in-class documentation support.