Developer Onboarding Guide
Created an end-to-end onboarding guide for a SaaS developer platform, consolidating scattered README files and wiki pages into a single structured experience.
- Organization
- Placeholder Client B
- Date
- March 2024
- Type
- Developer guides Docs-as-code Content strategy
Context
A developer tooling company had documentation spread across GitHub READMEs, a Notion wiki, and a legacy Zendesk help centre. New hires and external developers were spending their first days just finding the right document.
Challenge
No single source of truth. Content was duplicated and frequently out of sync. The team had no process for keeping docs updated alongside code changes.
Approach
Audited all existing content and mapped it to the developer journey from account creation to first production deployment. Proposed and implemented a docs-as-code workflow using Markdown in the main repository, with automated publishing on merge.
Outcome
Onboarding time for new developers reduced from an average of 3 days to 1 day. The docs-as-code workflow was adopted by the engineering team and is now part of the PR checklist.