Cherryleaf creates the API documentation your developers need and expect
Good API documentation builds developers’ confidence in your product. Developers expect to be able to find the information they need to get things done, code examples they can adapt, and a complete read-through for every function. What’s more, poor documentation can be seen as a sign of a badly-maintained API.
It can be hard to find the time to document your APIs so they are complete, up to date, and of a high quality. With your developers used to focusing on details, this can also lead to documentation that lacks the big picture perspective.
Need an API documentation writer?
Cherryleaf can create the API documentation your audience needs and expects. Alternatively, we can provide you with a Technical Author to work as part of your team. This can free up your developers, leaving them with more time to do what they do best.
“The first, laborious, step was to get all the information organized into documents in a structured and modular way. As we complete the process we will want to improve presentational aspects to give a better customer and marketing experience.
We see an ongoing role for Cherryleaf as consultants who can help to get better documents out of the vast material we have added to the system. Very importantly, Cherryleaf were able to rapidly respond to our issues with the system and help us understand. We have no expertise in this and did not want to be stuck on things that experts could solve instantly – Cherryleaf were very responsive in this. “
Fitting in with your existing development workflow
You may want to treat this documentation as code, committing it to source control, and including it in the builds. Cherryleaf can become part of your development process.
We can work in a way that you’re able to add content. For example, your subject matter experts can write a rough draft for a specific topic, and we can then turn that into user-friendly information.
Giving your developers the documentation they need
Cherryleaf can help you provide the types of information your users need. This can include:
- Getting started guides and tutorials
- Conceptual and overview guides
- Troubleshooting guides
- API reference guides
- Authentication and authorisation guides
Need help in developing your API documentation?
Complete the contact form below. Don’t worry if you don’t know the answers to all of the questions.
We will contact you to discuss your situation and requirements.
You can always phone or email us, if you prefer.