With the goal of improving the end-to-end experience of our client developers, two product managers, UX design manager, and I researched, interviewed, developed processes and prototypes, and determined best practices for our teams to ensure developer success in creating a new developer documentation center.
This project included determining a developer-oriented CMS (we chose ReadMe.io), updating our writing style and information architecture, documentation team training, and designing and implementing the aesthetic and functional elements of the documentation website.
I took part in every aspect of the project and led the styling updates, content migration, and doc team training. I held writing workshops and open office hours to guide the doc team to the new style and in learning Markdown syntax and formatting. I helped migrate developer content from IBM while the doc team continued writing new features and implementing the new style as they worked. I worked with the head of UX design to help implement the look, feel, and functionality tweaks to the ReadMe product.
I also used the knowledge of ReadMe features to bring in the glossary tool tip functionality to our Help Center documentation site powered by Zendesk.
As Acoustic divested from IBM, the content design team had a writing experience to practice a new style and tone for our business user audience. The main product I was in charge of during this transition period was Acoustic Campaign SMS.
The new style for the business end user documentation was more story-like with this sample as the overview of the product.
― Ami Dewar, Sr Manager of UX at Amazon Web Services (AWS)
― Megan Crouch, Owner and CEO at Wise Warrior Coaching
― Rita Moore, Manager at Socure