top of page

JFrog Artifactory User Guide

Context

As part of my re-certification in Technical Writing, the final assignment required me to write a few modules of the JFrog Artifactory User Guide and generate an HTML5 output using MadCap Flare. For the content, I was required to do my own research on the website, https://jfrog.com/artifactory/ and write the following modules:

  1. Setting the JFrog Platform

  2. How to use the JFROG Portal  

  3. Getting Started --> Build JFrog WorkFlow

  4.  Artifactory --> Builds

  5. Artifactory --> Artifacts

Approach

To write the introductory sections of the user guide, I performed the following research on the product website and the internet to improve my understanding:

  1. Gained understanding of the keywords used in the JFrog Artifactory website including DevOps, DevSecOps, and CI/CD pipeline.

  2. Learned about JFrog Cloud platform’s main business offering and its target audience.

  3. Learned about the platform’s features and its key products.

​

To write the modules on setting up the platform and getting started, I signed up for a14-day trial of the JFrog Cloud Platform. I documented the entire process by capturing screenshots and jotting down the steps. I then went to learn about the various elements of the UI followed by in-depth research of the two modules that needed to be included in the User Guide.

bottom of page