Manager Platform Enablement at Ford Motor Company
Ford as an API company The mission is to design, build, grow and invest in new mobility services. Mobility services require an ecosystem built around APIs.
Ford is an API driven company: data analytics, city solutions, autonomy, FinTech, fleet services, location services, predictive systems, charging networks, parking, smart ownership, ride sharing, vehicle history, telematics, infotainment.
Why is Ford doing DocOps?
Ford Mobility approach to DocOps
DocOps practices must encompass all content types
Lead API Documentation Writer at iManage
What CEOs see: a small group of writers can support a large group of programmers, and they only hire just enough writers along with automation to be able to produce a minimum set of documentation.
Writing great documentation
What about writing great documentation? Installing 100% confidence 100% of the time.
How we use APIs?
You’re never done writing
If it’s not already broken, then break it
Documentation engineer at Netlify
About Swagger & OAS
Sauntering in the direction of
Maintaining tech values
Assistant Professor at Mercer University
The conversion funnel
Documentation’s inverted funnel
Reference topics make your customers smarter
Read Bob Watson’s article about his talk.
Developer Evangelist at Contentful
What to do when nobody reads your docs?
RTFM (Read the Fancy Manual) can be harmful: “Not only am I not going to help you, but also I want to make sure that you feel ashamed about your inability to help yourself.”
Four ways of learning Documentation is only one of the tools used to educate people on how to use the product. You can support different ways of learning by providing the right form of documentation.
Areas of documentation Developer docs break down into three different levels:
Content & Documentation discovery When the documentation is too big to explore, reducing friction around information discovery is important.
More than text Documentation doesn’t need to be only static content: