A high-quality, well-structured user guide is key to making your customers feel valued and supported.
Without adequate documentation, the burden on your support staff will be much greater, and it can be difficult to keep your release notes in sync with your support material.
Red Robot Media has two technical authors with more than 15 years’ combined experience. We can:
- Create new user guides
- Write training documentation
- Fact check and update your documentation
- Update your documentation monthly, quarterly, or annually.
We offer accessible and affordable rates for small businesses and startups, so you only pay for the technical author when you actually need their support.
You can order a new user guide, or a one-off update to an out-of-date document, without further commitment.
You can also hire our technical authors to work on a retainer, or on-site with your own employees.
User Guide Examples
Our technical authors are highly experienced and have worked on both software and hardware user guides.
We’ve created complex help systems completely from scratch, and we’ve also updated and improved existing documents that are out of date.
Our flexible pricing for technical authoring services means that you never pay for more time than you need. We offer:
- Fixed quotes for one-off assignments
- Simple hourly rates for ongoing work.
Red Robot also offers a discounted rate for clients that hire us on retainer. Typically, a retainer agreement is a commitment to update and maintain documentation for three months or more.
- 1 User Guide Examples
- 2 Documentation Services
- 3 User Guide FAQS
User Guide FAQS
If you have a question that is not covered here, please contact us for a speedy reply.
Can you provide a fixed quote for my user guide?
In most cases, we can provide a fixed quote for a new guide, or an update to an existing guide. Sometimes we may need an overview or a site visit to understand how much work there is.
Do you write training material?
Yes, we do. We can develop training material independently of your user guide, or we can single-source all of the content and publish it in different ways.
What is single-sourcing?
Single-sourcing means that we only create one version of each topic, even if the topic recurs in multiple places in the manual, or even across different manuals in a set.
By writing each topic once, the manual becomes much easier to manage, and it ensures that all of your technical guidance is consistent across all formats and documents.
MadCap Flare is our preferred tool for single-sourced user guides.
Can I update the documentation myself?
Once we’ve completed your manual, we will send you the documentation and the source files. We recommend that you edit the source files, not the output. This ensures that your changes will be carried over to every future version.
If you want to be able to comment on our work, or suggest different wording, we strongly recommend that you use MadCap Contributor. This allows us to import your changes and comments into the original source file.
Our technical authors can provide training on MadCap software at your office or ours.
How do I publish my user guide?
Our technical writers can publish your user guides in a number of formats. The following is just a guide:
- Online: Forums, WebHelp, HTML5
- Digital: PDF, Word, Adobe InDesign, DITA, ePub
- Print: PDF, Adobe InDesign
- In-App: Context sensitive.
We include one output format when we quote for a user guide update, or a brand new set of documentation. If you require multiple formats, you can bolt this on for a small layout fee. Once the layout is created, the cost of outputting the manual to each format is typically very small.
All print and PDF (etc.) outputs come with a front cover, and all online outputs are designed for modern devices. If you have branding guidelines, we will produce all documentation accordingly.
Can you translate user guides?
Yes, we work with two trusted translation providers.
Can you proofread user guides?
Yes, we’ve successfully proofread user guides for a number of clients and would be pleased to quote for this.