Job purpose
- Own end‑to‑end documentation for Capital Market platforms and other financial and banking applications critical for global banks. Establish the documentation strategy, produce high‑quality developer and operator content, and create a sustainable docs‑as‑code practice that accelerates onboarding, reduces support burden, and improves change velocity.
- Work cross‑functionally with business, engineering and delivery teams in the App Dev workstream
Key responsibilities
Own the Platform documentation portfolio: architecture overviews, service/component guides, integration patterns, API/SDK reference, data contracts, runbooks/SOPs, troubleshooting guides, and release notes.
- Establish documentation standards & IA: define templates, taxonomy, versioning, and content lifecycle; implement style and terminology guides aligned to CLIENT expectations.
- Adopt a docs‑as‑code workflow: source control, PR reviews, automated build & publish (MkDocs/Sphinx/Docusaurus or other documentation platforms), search, and link integrity checks; integrate with GitHub/Azure DevOps and CI (e.g., Jenkins).
- Author API/SDK content: collaborate with developers to produce OpenAPI/Swagger‑driven reference, code snippets, authentication/authorization flows, rate‑limits, and usage examples.
- Document data flows: capture upstream/downstream dependencies, batch/near‑real‑time ingestion patterns, data validation/audit trails, and operational guardrails; maintain data dictionaries and lineage notes where applicable.
- Create operator‑grade runbooks: incident playbooks, SLO/SLA documentation, monitoring/alerting handbooks, change management checklists, and rollback procedures.
- Partner across time zones: run SME interviews, doc clinics, and content reviews with CLIENT stakeholders in New York/London; drive crisp approvals and publication cadences.
- Measure impact: define and track documentation KPIs (adoption, search success, time‑to‑onboard, ticket deflection).
Key competencies
- 8–12 years of technical writing experience, with 5+ years on complex enterprise platforms (preferably banking/capital‑markets).
- Demonstrated ownership of a developer portal or large product documentation set (architecture API operations).
- Strong ability to read code/configs and interrogate systems: familiarity with API exploration (Swagger/Postman), logs and dashboards, and basic scripting/SQL to validate flows.
- Tooling: Markdown, static site generators (MkDocs/Sphinx/Docusaurus), OpenAPI/Swagger, diagramming
- (Mermaid/draw.io/Visio), Confluence; comfortable working in GitHub/Azure DevOps and CI (e.g., Jenkins).
- Exceptional structuring, editing, and stakeholder management ; can transform tribal knowledge into clean, reusable artifacts.
- Portfolio required: 2–3 samples of API/SDK docs and one architecture/runbook example (links or PDFs).
- Background documenting platform integrations (APIs/SDKs, data extract/load patterns, SFTP and batch pipelines) and governed data sets.
- Exposure to capital‑markets workflows and middle/back‑office systems.
