From 4777d96c420fe1989544828a85824b49b1365b53 Mon Sep 17 00:00:00 2001 From: g* Date: Wed, 5 Nov 2025 10:18:34 +0100 Subject: [PATCH] Added the last portfolio item. --- docs/resume/establish-spread-docs.md | 52 +++++++++++++++++++---- docs/resume/mambu-cli.md | 12 ++++-- docs/resume/mambu-process-orchestrator.md | 20 +++++---- 3 files changed, 64 insertions(+), 20 deletions(-) diff --git a/docs/resume/establish-spread-docs.md b/docs/resume/establish-spread-docs.md index ee4ff41..0497015 100644 --- a/docs/resume/establish-spread-docs.md +++ b/docs/resume/establish-spread-docs.md @@ -1,6 +1,6 @@ --- -title: PcVue assessment -description: An assessment of the documentation provided by PcVue. +title: Establish SPREAD documentation +description: An overview of how I established the documentation function at SPREAD. hide: # - toc - navigation @@ -13,27 +13,63 @@ hide: border-radius: 5px; } - .tooling { - font-family: var(--secondary-font); +div.tooling { + margin: 1.5em 0; +} + +div.tooling p { + font-family: var(--secondary-font) !important; font-weight: bold; - } +} > ### Brief
> **February 2022**
> Establish the documentation function at SPREAD. -:simple-materialformkdocs: MkDocs Material | :material-graphql: GraphQL | :material-language-javascript: JavaScript | :material-language-python: Python | :simple-jinja: Jinja | :material-language-markdown: MarkDown | :simple-v: Vale | :simple-githubactions: GitHub Actions | :material-docker: Docker +
:simple-materialformkdocs: MkDocs Material ⋅ :material-graphql: GraphQL ⋅ :material-language-javascript: JavaScript ⋅ :material-language-python: Python ⋅ :simple-jinja: Jinja ⋅ :material-language-markdown: MarkDown ⋅ :simple-v: Vale ⋅ :simple-githubactions: GitHub Actions ⋅ :material-docker: Docker
![An image of the current version of the SPREAD documentation site](/src/spread-docs-v3-3456x2170.png){ height=300px } ## Challenge -Mambu Process Orchestrator - a white-labelled product built on top of the Corezoid low-code engine - had no documentation, but was already being used by clients. Some with highly complex workflows taht were beginning to break in unexpected ways in an environment where no failure could be tolerated. The underlying technology was built by a Ukranian company, who were under strain following the invasion by Russia in the same time period. +There was no documentation, except for a few Confluence pages put together by engineers. The challenge was to create a documentation site, create the processes and pipelines to maintain it, and to write the content. The task was made more difficult by the fact that the product was constantly changing and I had engineering time to lean on. ## Solution -Partner with Corezoid to help them develop their documentation alongside ours. Get field-tested best practices from clients who were using the tool. Ask the Solution Engineers to sketch out the most urgent work needed and teh scope they cover when workign with clients. Compile a documentation set in the shortest time possible to fill this documentation gap. +**In the first three months:** + +- Evaluated and selected options for the technical infrastructure. +- Socialized the newly established function in the company. +- Created the internal website. +- Created the initial build pipelines. +- Got to 50% product coverage. +- Wrote an initial style guide for general contributions + +![The first published version of the SPREAD docs site](/src/spread-docs-v1-3024x1890.png){ height=300px } + +**In the second quarter:** + +- Got product coverage to 90%. +- Moved to multi-repo setup, where engineering teams "owned" their content and maintained updates. +- Built the linting pipelines for general contributions. +- Document white-labelled products with internal customisations. + +![The first public version of the SPREAD docs site](/src/spread-docs-v2-3024x1890.png){ height=300px } + +**Within the first year:** + +- Publish the documentation site publicly. +- Publish the SPREAD glossary of terms. +- Create course content for new users. + +**Within the last year:** + +- Move to a mono-repo setup. +- Create more course content. +- Add AI enhancements to the build pipeline. +- Better monitoring of product changes. +- Re-start initiative for more people to write documentation.
See the site
 diff --git a/docs/resume/mambu-cli.md b/docs/resume/mambu-cli.md index 5bf593c..85d8a8b 100644 --- a/docs/resume/mambu-cli.md +++ b/docs/resume/mambu-cli.md @@ -13,17 +13,21 @@ hide: border-radius: 5px; } - .tooling { - font-family: var(--secondary-font); +div.tooling { + margin: 1.5em 0; +} + +div.tooling p { + font-family: var(--secondary-font) !important; font-weight: bold; - } +} > ### Brief
> **November 2023**
> Create documentation for a command-line interface (CLI) used by banking engineering teams to perform actions in Mambu. -:material-language-typescript: TypeScript | :material-nodejs: NodeJS +
:material-language-typescript: TypeScript ⋅ :material-nodejs: NodeJS
![An image of the Mambu CLI](/src/mambu-cli-1638x1355.jpg){ height=300px } diff --git a/docs/resume/mambu-process-orchestrator.md b/docs/resume/mambu-process-orchestrator.md index 61c91f5..db4c40e 100644 --- a/docs/resume/mambu-process-orchestrator.md +++ b/docs/resume/mambu-process-orchestrator.md @@ -1,6 +1,6 @@ --- title: Mambu Process Orchestrator -description: An assessment of the documentation provided by PcVue. +description: An overview of how I documented a feature set at Mambu. hide: # - toc - navigation @@ -11,29 +11,33 @@ hide: img { border: 0.5px solid #ededed; border-radius: 5px; - } +} - .tooling { - font-family: var(--secondary-font); +div.tooling { + margin: 1.5em 0; +} + +div.tooling p { + font-family: var(--secondary-font) !important; font-weight: bold; - } +} > ### Brief
> **March 2021**
> Own the documentation for the low-code orchestrator for integrations into banking services. -:simple-hugo: Hugo +
:simple-hugo: Hugo
![An image of a process in the Mambu Process Orchestartor](/src/mpo-complex-process-2355x1237.png){ height=300px } ## Challenge -Mambu Process Orchestrator - a white-labelled product built on top of the Corezoid low-code engine - had no documentation, but was already being used by clients. Some with highly complex workflows taht were beginning to break in unexpected ways in an environment where no failure could be tolerated. The underlying technology was built by a Ukranian company, who were under strain following the invasion by Russia in the same time period. +Mambu Process Orchestrator - a white-labelled product built on top of the Corezoid low-code engine - had no documentation, but was already being used by clients. Some with highly complex workflows that were beginning to break in unexpected ways in an environment where no failure could be tolerated. The underlying technology was built by a Ukrainian company, who were under strain following the invasion by Russia in the same time period. ## Solution -Partner with Corezoid to help them develop their documentation alongside ours. Get field-tested best practices from clients who were using the tool. Ask the Solution Engineers to sketch out the most urgent work needed and teh scope they cover when workign with clients. Compile a documentation set in the shortest time possible to fill this documentation gap. +Partner with Corezoid to help them develop their documentation alongside ours. Get field-tested best practices from clients who were using the tool. Ask the Solution Engineers to sketch out the most urgent work needed and the scope they cover when working with clients. Compile a documentation set in the shortest time possible to fill this documentation gap.
Read the documentation set