Updating Meta’s developer docs for new AI ad product

Case study hero image

Overview

I was on a Facebook team focused on improving lead ad quality for advertisers. I came in halfway through a major redesign of a manual CRM integration flow for a new AI ad product.

A number of articles on Facebook’s Business Help Center and Meta’s Developer Docs websites had to be updated and also written from scratch to walk users through the redesigned flow.

I worked with the Business Solutions Engineer, Product Manager, and others to write and edit multiple documents so users could have a clear understanding of how to manually integrate their CRM.

Meta developer documentation project overview
Meta CRM integration workflow

The developer docs helped guide users through the process of connecting their company’s CRM to Meta.

What I did

Technical documentation updates for Meta developer docs

I also had to work with the team to decide how much guidance to give in-product versus when to send them to the help docs. My rationale for how to approach this was that if the instruction could be simplified and shortened to a few bullets (seen above), leave it in-product. If it required more steps, send them to a longer doc.

Meta onboarding documentation improvements

Getting the documentation right was crucial since lack of documentation was one of the biggest pain points from user testing (users being developers). This is the final article that matches the exact new redesigned user flow and uses diagrams to explain it as simply as possible.

Meta developer implementation documentation

Another final article. Bullet points at the top explain exactly what’s in this guide. “Step 1” language makes it clear they’re starting in the right spot and the numbered steps to the left allows them to pick up where they left off if they have to break off. Bold text makes it clear when we are referring to UI elements in the flow.

Cross-functional collaboration for Meta developer docs

A big pain point in user testing was that some advertisers would not be a good fit for this new AI product. But they did not know it so were starting the integration and wasting time only to find out later it wasn't worth it. So I made it easy for advertisers to see if this was a good fit for their business with bullet points for scanning and a clear headline to grab their attention.

Challenges

Meta documentation publishing workflow

Another challenge I faced was that there were multiple different places the articles were located across Meta’s help center. After I met with other teams, I discovered other places that needed updating that were not in scope. Besides the “Meta for Developers” main site, there was another site “Meta Business Help Center” that also needed updating. This is an example of the final article in the Business Help Center that I updated to match the other guides that were updated.

Meta system-level content documentation updates

Another final article explaining how to connect the CRM through a third-party like Zapier.

Support documentation for Meta advertisers and developers

Some articles were a bit redundant because of the size of Meta's help center but since it was not in scope to deprecate some of these articles owned by other teams, I worked with partners to update them so at least they matched the new redesigned flow.

Final Meta developer documentation outcomes

I also drove the process of updating and posting the public-facing articles in a timely manner working with the Editorial leads and review team so everything was ready for launch.

Meta documentation publishing workflow

The checklist I made to make sure nothing was missed during the process and before launch.

Business results

User results