Docs modernization & migrations
Migrating Backbase documentation to a new site
The situation
Backbase's documentation was maintained on an Asciidoc-based internal site with some major limitations and bottlenecks that prevented our documentation team from innovating, and slowed down our productivity. For one thing, each product required a versioned docset, and versions were maintained on their own release branches - this meant that any feature that impacted more than one version needed to be cherry-picked back across multiple branches with their own PRs that each needed reviewing. Additionally, the documentation was situated within the product monorepo, which curtailed our ability to develop features that would have elevated the site to a fully-fledged documentation portal.
What I did
- Helped redesign the content architecture, so the new site is organized around what readers need to find, not around how the old site had grown.
- Did much of the heavy lifting of the migration, moving content onto the new platform section by section.
- Fixed content on the way across: broken formatting, links, and structure, plus pages that needed rewriting to fit the new architecture.
Result
The full documentation site moved to the new platform, with a clearer structure and cleaner content than the one it replaced.
- Client
- Backbase, engagement banking platform
- Date
- June 2023
Have a similar project?
Get in touch →