As part of my hiring process for Mambu, a SaaS cloud banking platform, I performed an audit of their Tasks API documentation. The resulting editing changes and points of clarification can be found in this repository.
"Take the API definition for the Tasks API and (using the information in our user guide) add a general description as well as more informative descriptions for each endpoint.
The goal of the task is that a reader should not have to switch between the API and user docs to understand what Tasks are in Mambu and how to work with and manipulate them."
- Changes were to be added to the existing Swagger file
- Additionally, a standalone HTML file was requested, documenting the results of a UI documentation page audit
- The modified Swagger file
- Documentation of missing information & suggestions
- Standalone HTML file of a UI documentation audit
While working at Mambu, I was responsible for the API and UI documentation of the Lending product line. This included the following API documentation:
- Installments
- Loan Products
- Loan Products Configuration
- Loan Accounts
- Loan Account Collateral Assets
- Loan Account Funding
- Loan Account Planned Fees
- Loan Account Tranches
- Loan Transactions
- Loan Risk Levels Configuration
Note
Since Mambu's documentation is live and updated regularly, changes could have been made to the links in this README since I left the company.