apidays New York 2023 - How to Make Your Docs Stand Apart, Ash Arnwine, Nylas

apidays New York 2023
APIs for Embedded Business Models: Finance, Healthcare, Retail, and Media
May 16 & 17, 2023

How to Make Your Docs Stand Apart
Ash Arnwine, Director of Developer Relations at Nylas

------

Check out our conferences at https://www.apidays.global/

Do you want to sponsor or talk at one of our conferences?
https://apidays.typeform.com/to/ILJeAaV8

Learn more on APIscene, the global media made by the community for the community:
https://www.apiscene.io

Explore the API ecosystem with the API Landscape:
https://apilandscape.apiscene.io/

Transcript

1. Houston, we have a Docs problem Ash Ryan Arnwine, Director of Developer Relations, Nylas indieweb.social/@ashryan Re–commitment to developers through Docs
2. 2 First, why does this matter?
4. 4 Stop the Freefall Assess the situation and get moving
5. User Experience debt Understanding your current state of Docs Technical Debt Information Architecture debt
6. 6 Developer Advocates Customer-Facing Teams Find the allies and helpers Engineers
7. 7 Leadership buy-In Where is this impacting customers today? Where is this putting strain on the organization? What do we lose if we don’t do this?
8. 8 Strategy & Execution Process Hiring a team Technical Chops
9. 9 Orchestrate the Upswing Proactive and Reactive Docs
10. Start Reactive Create open and clear lines of communication 🗣 Uncover customer feedback whenever you can 🔎 Find and extinguish the fires 🔥
11. Get Proactive Get involved in the PDLC/SDLC process 🔧 Establish efficient and repeatable workflows 📝 Draft a roadmap and get feedback 🚀
12. 12 To Infinity and Beyond Going beyond words on a page to truly delight your developers
13. 13 • Onboarding journeys • Naming things • Dev tools • Feedback tools • Technical and strategic SEO • Changelog and release notes • Docs features Docs is more than “Docs”
15. 15 Great Docs at Work G2 Crowd review Nylas has been a great partner and their API has been a blessing that solved a lot of business issues for us. Also, it's documentation is by far more details than any other product out there.
16. The next frontier GitHub Copilot for Docs DocsGPT
17. The next frontier Talking to your OpenAPI spec with ChatGPT
18. Key Takeaways • Assess your current situation • Get started now with what you have • Hire for well-rounded skill sets • Start reactive • Get proactive • Docs is more than “Docs”
19. Helpful Resources • Book: Docs for Developers ◦ docsfordevelopers.com • Community: Write the Docs ◦ writethedocs.org • Blog post: “Experimenting with AI in DevRel” ◦ ashryan.io/experimenting-with-ai-in-devrel
20. 20 Want to work with Nylas DevRel? • Developer Advocacy team • Developer Documentation team <- WE’RE HIRING
21. We’re hiring • Technical Writer (Remote in U.S. or Canada) • Eng (ML, SRE, QA) • PMM • BDR • And more! nylas.com/careers