Here are some examples of different types of documents we’ve developed that you can see on the web.
API documentation example
elearning module example
See the examples in the WriteLessons section of our website.
Knowledge Base example
Getting Started Guide example
Online Help file example
Available on request.
Policy and procedures examples
- ABC Co Employing new staff policy (pdf)
- Management processes (online)
- Staff handbook example – responsive web layout
Pre- and Post- Brexit procedures examples
Below are two proof of concept examples of a policy document. In these examples, the selling old mobile phones topic contains a filter for pre- and post- Brexit information. Users can use the filter option to switch between both versions.
The benefit of doing this is because the reader doesn’t get overwhelmed with information, and the writer can manage the both sets of information in a single topic.
- Mobile phone policy – version 1 (online)
This example has tabs on the left hand navigation panel.
The funnel icon () tab enables you to exclude content. In this example, you can exclude pre- and post- Brexit information on the selling old mobile phones topic.
The A-Z folder icon () tab enables departments, budget holders and line managers to see which topics are relevant to them.
- Mobile phone policy – version 2 (online)
In this example, you can exclude pre- and post- Brexit information on the selling old mobile phones topic by using the drop down menu at the top of the topic.
It also contains a job role tab that enables departments, budget holders and line managers to see which topics are relevant to them.
Click on the menu icon () to display the navigation window.
User Guide example
Note: We developed this for our live training courses in 2013. We did not develop this for Google themselves.
Available on request.
Why providing examples is difficult for technical writing companies
Providing examples can be difficult:
- We are nearly always under a non-disclosure agreement with our clients.
- The information is sometimes integrated with the software. This means you’d need to buy and install the application if you wanted to see the content. In other cases, the content may be on the web, but behind a firewall.
- We also give our clients the capability to make changes over time themselves. This means the content on websites might not be what we created originally.
You might gain a better understanding of our capabilities by looking at the case studies from documentation projects.
Need help with creating content for your users?
Want to discuss your situation, and explore how Cherryleaf can help you? You can tell us about your project, issues and goals. We’re here to help.