Promoted to team lead; managing a team of three technical writers.
-
Documented the Mambu ecosystem
-
Documented integrations, such as payment and compliance services, and the low-code orchestrator that clients used for their flows.
-
Documented a command-line interface
+
Documented the Mambu ecosystem
+
Documented integrations, such as payment and compliance services, and the low-code orchestrator that clients used for their workflows.
+
Documented a command-line interface
Documented the Mambu CLI for external engineers to connect to the backend directly.
-
Assumed leadership role
-
Promoted to team lead, which shifted the role into more managerial responsibilities on top of working on documentation.
+
Assumed leadership role
+
Promoted to team lead, which shifted the role into more managerial responsibilities - on top of working on documentation.
@@ -71,13 +71,13 @@ title: Resume
Documentation Engineer
SPREAD 2024 to 2026
-
Hired as the first Technical Writer to establish the documentation function.
+
Hired as the first Technical Writer to establish the documentation function.
-
Built a docs-as-code publishing pipeline
+
Built a docs-as-code publishing pipeline
Built a pipeline that used GitHub Actions to build the documentation site, Vale to lint content, Docker to deploy the site, and shell scripting.
-
Established the documentation function
+
Established the documentation function
Socialized the rest of the company to documentation processes and workings; this included onboarding colleagues to edit and use docs.
-
Documented the full product range
+
Documented the full product range
Documented the full product range within two quarters. Kept the documentation up to date through two product refreshes.
@@ -86,39 +86,237 @@ title: Resume
-
+
+
+
+
+
+
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 that were beginning to break in unexpected ways. 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 Mambu. 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.
+
+
+
+
+
+
+
+
+
+
+
Challenge
+
Document the command-line context as efficiently as possible, with little support from the developing team. Mambu CLI was in prototype and the team had no time to help me document the commands, flags, topics, and functioning of the CLI.
+
Solution
+
Embedded documentation with the engineering team, where I was part of the race to beta. Engineers would develop a feature alongside me and I would be in the code documenting. This involved working in TypeScript and translating the concepts and trials engineers were developing with them.
+
+
+
+
+
+
+
+
+
+
Challenge
+
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.
+
Solution
+
In the first three months:
+
+
Evaluated and selected options for the technical infrastructure.
+
Socialized the newly established function in the company.
+
Created the internal documentation website for testing.
+
Created the initial build pipelines.
+
Got to 50% product documentation coverage.
+
Wrote an initial style guide for other contributors.
+
+
+
+
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 contributions from engineers.
+
Documented white-labelled products with internal customisations.
+
+
+
+
Within the first year:
+
+
Published the documentation site publicly.
+
Published the SPREAD glossary of terms.
+
Created course content for new users.
+
+
+
Within the last year:
+
+
Moved to a mono-repo setup.
+
Created more course content.
+
Added AI enhancements to the build pipeline.
+
Bettered monitoring of product changes.
+
Re-started initiative for more people to write documentation.
-
-{ height=300px }
-
-## Challenge
-
-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
-
-**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
-
-{ 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.
-
-{ 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.
-
-
-
-{ height=300px }
-
-## Challenge
-
-Document the command-line context as efficiently as possible, with little support from the developing team. Mambu CLI was in prototype and the team had no time to help me document the commands, flags, topics, and functioning of the CLI.
-
-## Solution
-
-Embedded documentation with the engineering team, where I was part of the race to beta. Engineers would develop a feature alongside me and I would be in the code documenting. This involved working in TypeScript and translating the concepts and trials engineers were developing with them.
-
----
-
-
diff --git a/content/resume/mambu-process-orchestrator.md b/content/resume/mambu-process-orchestrator.md
deleted file mode 100755
index 09f4fbe..0000000
--- a/content/resume/mambu-process-orchestrator.md
+++ /dev/null
@@ -1,59 +0,0 @@
----
-title: Mambu Process Orchestrator
-description: An overview of how I documented a feature set at Mambu.
-hide:
- # - toc
- - navigation
- - search
----
-
-
-
-> ### Brief
->
-> **March 2021**
-> Own the documentation for the low-code orchestrator for integrations into banking services.
-
-
:simple-hugo: Hugo
-
-{ 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 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 the scope they cover when working with clients. Compile a documentation set in the shortest time possible to fill this documentation gap.
-
-
diff --git a/content/test.md b/content/test.md
deleted file mode 100755
index f506814..0000000
--- a/content/test.md
+++ /dev/null
@@ -1,29 +0,0 @@
----
-title: test
----
-
-The HTML specification is maintained by the W3C.
-
-
-- :fontawesome-brands-html5: __HTML__ for content and structure
-- :fontawesome-brands-js: __JavaScript__ for interactivity
-- :fontawesome-brands-css3: __CSS__ for text running out of boxes
-- :fontawesome-brands-internet-explorer: __Internet Explorer__ ... huh?
-
-
-
-*[HTML]: Hyper Text Markup Language
-*[W3C]: World Wide Web Consortium
-
-
-
diff --git a/requirements.txt b/requirements.txt
index fc34519..f5d1bd6 100755
--- a/requirements.txt
+++ b/requirements.txt
@@ -16,9 +16,9 @@ mkdocstrings==1.0.3
mkdocstrings-python==2.0.2
packaging==26.0
pathspec==1.0.4
-platformdirs==4.7.1
+platformdirs==4.9.1
Pygments==2.19.2
-pymdown-extensions==10.20.1
+pymdown-extensions==10.21
python-dateutil==2.9.0.post0
PyYAML==6.0.3
pyyaml_env_tag==1.1
diff --git a/zensical.toml b/zensical.toml
index 9ac0374..eae52a7 100755
--- a/zensical.toml
+++ b/zensical.toml
@@ -94,7 +94,7 @@ permalink = true
[project.theme]
custom_dir = "content/overrides"
-favicon = "assets/media/face-1276x1276.png"
+favicon = "assets/media/face-favicon-512x512.png"
language = "en"
logo = "assets/media/face-1276x1276.webp"
palette.primary = "custom"
- 
- 
+ 
+ 
+ 
+ 
+ 
Doc Detective
+ + Docker +++ Dokploy +++ GraphQL +++ Hugo +++ JavaScript +++ Jinja +++ Markdown +++ MkDocs Material +++ OpenAPI +++ Python +++ Shell +++ TypeScript +++ Vale ++++
Zensical
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+