Wednesday, August 7, 2024

Writing Samples

The list of samples on this page covers some of my latest technical writing work. 

These pages and videos are all related to the Tanzu Observability by Wavefront project, which was at some point was renamed to Operations for Applications. Since the product is dynamically changing (it's a SaaS product), the links to the doc pages are links to the versions I have authored and submitted in the Wavefront open-source GitHub documentation repository.

Wavefront is a high-performance streaming analytics platform that supports observability for metrics, counters, histograms, and traces/spans. 

All doc pages published to the documentation website are written in markdown and stored in GitHub. For this particular product, I have also worked on:
  • Release notes
  • Pendo guides
  • Online help
  • UI strings
I also redesigned the landing page of the website, managed to implement a Copy button which appears on each code snippet, so that customers can easily copy the sippets and maintained the Java script which we used to pull content from the engineering repository and publish it to the documentation website. 

If you need more samples, I can send more as PDFs.

Tutorials

Documentation pages

  • Search for Content and Save Searches
    Video scenario, screen capture, and voice over audio are done by me. The video is created with Camtasia.
  • Send Metrics from a Windows Host
    Video scenario, screen capture, and voice over audio are done by me. The video is created with Camtasia.
  • How to Use PromQL
    Video scenario and screen capture are done by me. The video is created with Camtasia. The engineer who was working on the feature did the voice over audio recordings.

No comments:

Post a Comment