Technical Writing Projects

Here is a showcase of my Tutorials, Guides, Information Architecture, and API documentation projects.

Information Architecture Analysis of the TUF Website

Information Architecture Analysis of the TUF Website

  • Completed
  • May 2024
  • August 2024
  • Sandra Dindi
  • Patrice Chalin

This project was part of the Linux Foundation mentorship program.I focused on analyzing The Update Framework (TUF) documentation and providing improvement according to the CNCF standards.I worked with several mentors from CNCF and TUF to provide improvement to the current website which included creating a new documentation website.

TUF

CNCF

Docsy

TUF Website Design

  • Completed
  • Sandra Dindi
  • Patrice Chalin

After the TUF website analysis, I designed a new website with a new Information Architecture based on the Hugo Docsy theme.

Kubernetes Glossary for SemaText Group

  • Finished

This tutorial introduces the concept of Quality of service (QoS)classes and shows the learner how to correctly configure the QoS classes in a pod for resource management.This is one of the projects I worked on together with the platform enginners and documentation team to create several tutorials on Kubernetes tools and features.

Kubernetes

DevOps

Technical Guides and Tutorials

How-to-guide for Early Access

    A product guide I wrote for Earlyaccesshq.com. It makes it easier for users to optimize the product’s advanced features to create a wailist tailored for business and marketing campaigns.

    earlyaccess

    CI/CD with GitHub Actions

      This is a How-to-guide on how to use Git Actions in DevOps processes to manage modern, cloud-native applications requiring fast and frequent updates.This was a personal project, a step-to-step guide on building, testing, and deploying merged pull requests to production with GitHub ActionsProjects portfolio

      githubactions

      cicd

      Blog Posts

      Marketing and Procedural Articles

      Make Use Of (MUO)

        I have a collection of Blogs from several websites. This is one from the Make Use Of (MUO) website.

        My Hashnode blog

          I write about the new technologies that I’m learning on this blog

          API Documentation

          Personal projects on API Docs

          Twilio API Reference Documentation on Readme.io

            A personal project trying to document the Twilio API on Readme.io

            TMDB Movies API Reference Documentation on Postman

              A personal project trying to recreate the TMDB Movies API reference documentation Postman