Technical Writer Skills - Using Nextra

This project showcases technical writing skills by developing documentation using the Nextra framework. The documentation is structured into two main parts, explained below.

It was developed using the nextra-docs-template (opens in a new tab).

Part 1

• This part is based on the usage of the Ghost (opens in a new tab) user interface.
• The content is focused on common tasks that an entry-level user could complete.
• The menu structure presents the more common tasks such as Getting started; publishing, editing, deleting, and managing posts; account management, and advanced configurations. It is organized following an incremental order, starting with the easier or initial tasks and going to more advanced content.
• The project includes a few guides with content. These guides are marked with the memo emoji (📝). The rest of the files are empty, being created to improve presentation.

Part 2

• This part is based on the REST services provided in this page (opens in a new tab).
• The section includes a general reference (opens in a new tab) presenting the API and explaining the available endpoints: retrieve data, create a new record, update a record, and delete a record.
• Besides the documentation in this project, the endpoints are documented in Postman (opens in a new tab).
• Before documenting the endpoints, they were also tested via Postman. In this matter, the Update a Record endpoint returned Error 404 in different moments.