Academic Projects

This study contains research on best practices for API documentation for users and developers. WPI students with experience in programming resources like forums and official API documentation participated in surveys that assess positive and negative elements of official API documentation. Best practices were recommended and implemented in a documentation set that includes a user guide and standard operating procedure related to API development. 

This standard operating procedure is intended for future computer science MQP teams working with 7Factor on their Webhooks-as-a-Service (WaaS) API that was started in a 2021-2022 Major Qualifying Project (MQP). The tasks that will be covered include procedures recommended by the prior team to continue building the WaaS API. The recommendations are outlined in the Webhooks-as-a-Service: A Custom API Design report. This SOP shows WPI student developers how to get started working with the current codebase and materials. It introduces tasks that are to be worked on during the course of their MQP, an extension of the WaaS API.

This user guide outlines the key features implemented by 7Factor's Webhooks-as-a-Service (WaaS) API, started in a 2021-2022 Major Qualifying Project (MQP). A summary of how the custom API was designed is outlined in the Webhooks-as-a-Service: A Custom API Design report. The user guide serves to introduce API features to future teams as they work on their MQPs as extensions of the WaaS API. The guide covers the basic functionality and setup of the API's database and server, which handle webhook payloads, connection actions, and connection requests.

This is a project I completed for a technical writing course (WR 3210) I took at WPI. I wrote a commercial-grade user guide for a product of my choice, the Nintendo Switch Lite. In writing the guide, I role-played as a member of Nintendo's documentation team to create a professionally formatted document that users would find credible and resourceful.

This research project involved researching a documentation set on a software product of my choice, Zoom, and writing a thorough analysis. It showcases what I have learned about what goes into an effective documentation set. The set I chose was specifically Zoom's Help Center and Developer documentation. Notable features I researched include user guides, video tutorials, support topics, and API reference materials.