PHS
I spearheaded and executed a 6 week documentation overhaul that revolutionized the client's content editing experience.Note: this GitHub repository is private
My largest contribution to the PHS site to date was a major documentation effort.
The Context
The PHS website is robust. It includes sub sites for each hospital location, custom apps and widgets, and components with multiple variations. I was tasked with reworking and fleshing out their Storybook documentation focusing on the content editing experience.
The Prep
In preparation of the 6 week project, I audited the incomplete documentation and made extensive notes on formatting, content, and how documentation pieces should be linked to one another. This detailed prep work allowed my team to create an accurate project proposal.
The Work
Once the project kicked off, I set to work confirming that every component, module, and template available in Contentful had a corresponding Storybook instance.
Each instance follows this format:
Overview
Name
Blurb (what the component does)
Usage
How it can be added to a page
What it should be used for
Fields overview
Each field available within Contentful is named and the data type specified
Fields Details
Each field is explained in detail
Canvas
A fully interactive canvas in which users could update data entered, select style variants, and view each component's responsiveness
The Result
All documentation instances were hyperlinked according to what pieces fit where. The end result totaled over 140 instances of documentation including 21 templates, 50 components, and 10 guides.
This project was a very large value add for the client. It has directly assisted with troubleshooting and future proofing their site.
