Let Cherryleaf write your API documentation
Having Cherryleaf’s technical communicators write your API documentation is a great way to free up your developers’ time. As a result, they can focus on what they do best. We can provide you with a technical communicator to work on or off site, depending on your preference.
“PSD2 and open banking is all about APIs. And an API is almost impossible to use without documentation. This means your PSD2 strategy needs to include a strategy for creating and delivering up-to-date API documentation.”
Good API documentation builds developers’ confidence in your product.
This can include:
- Getting started guides and tutorials
- Conceptual and overview guides
- Troubleshooting guides
- API reference guides
- Authentication and authorisation guides
Developers expect to be able to find the information they need to get things done. They want 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. With your developers used to focusing on details, this can also lead to documentation that lacks the big picture perspective. The answer is to have an API documentation writer on your team.
“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
Cherryleaf’s API documentation writers can become part of your development process. You could treat documentation as code, committing it to source control, and including it in the builds.
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.