What I thought was an API Documentation☺️ VS what it really is🥵

During a session with my mentor, Robert Delwood. He emphasized on the importance of thoroughly describing my endpoint parameters, and learning to anticipate questions from the users' minds to guide my descriptions.

One of the best gifts @TWMP gave me (besides the cash prize) for graduating as a top mentee is an opportunity to be mentored (personally) by Robert Delwood😇

I started this program barely knowing a thing about API testing or documentation, but look who finished with 3 solid projects in her portfolio and a fully customized API Docs (capstone project) that won first place!🤭 If this is not growth, then I don't know what it is☺️

Using similar products as the products you create is an actual way to empathize with users. Because then, you get to experience the pains and frustrations first hand, and you know exactly what to improve on. My experience with TMDB API docs information architecture right now😩

And that right there is the role of a UX professional.

This might be the longest YAML code I have seen yet🥵 So I am finally exploring the OpenAPI specification for my capstone project, and it looks like I'll be spending the next couple of days here😤 If you're experienced with this, I'd appreciate some tips and best practices.🙏

The holiday is over and I'm back to testing and documenting APIs!✨ Finished testing the endpoints for my @TechnicalWriti6 capstone project today! 150 endpoints in total!🤭 Up next: Export and document on OAS!🚀🚀

Gm Crypto Twitter👋 I'm Liz, a Technical Writer I'll be delving more into Blockchain API Documentation this year. If you're a Dev, PM, Hiring Manager, or working with similar tools... Let's connect!😊