Technical Writing
Dropbox
- What to do if the Dropbox desktop app unexpectedly quits or is causing apps to crash
- How to create and send a transfer
- Dropbox Sign and NOM 151 Compliance
- How to use dynamic filters
- What happens when I activate the Dropbox Sign Google Drive integration?
- Can I prepare Google Drive documents to be signed in Dropbox Sign?
Collibra
- Guided Stewardship
- Logical Data Layer (selected sample)
- Data Classification Dashboard (selected sample)
- Episode 260 | Migrate Your Kafka Cluster with Minimal Downtime | March 1, 2023
- Episode 258 | What is the Future of Streaming Data? | February 15, 2023
- Episode 255 | How to use OpenTelemetry to Trace and Monitor Apache Kafka Systems | February 1, 2023
- Episode 254 | What is Data Democratization and Why is it important? | January 26, 2023
- Episode 249 | Top 6 Worst Apache Kafka JIRA Bugs | December 21, 2022
-
Episode 247 | Building and Designing Events and Event Streams with Apache Kafka | December 15, 2022
-
Episode 246 | Rethinking Apache Kafka Security and Account Management | December 8, 2022
-
Episode 245 | Real-time Threat Detection Using Machine Learning and Apache Kafka | November 29, 2022
-
Episode 244 |Improving Apache Kafka Scalability and Elasticity with Tiered Storage | November 22, 2022
As a key contributor to the API documentation team, I was tasked with writing topic-based how-to articles, tutorials, and user guides for the Collibra developer portal.
Count the number of assets in a domain with the REST API is an example of a tutorial that walks users through the process of using REST API to count the total number of assets in a domain.
To create this tutorial, I gathered all of my source materials and information through a series of interviews with product managers and subject matter experts. Using my amateur coding skills (I do not claim to be a developer), I also wrote the code samples in the procedures.
Because the Collibra documentation is published in both HTML and in PDF format, I wrote the content in Madcap Flare, generated the HTML code, and then copied it to the developer portal which is hosted in WordPress. This multi-step publishing process allowed me to create the content in a single-source and publish in different formats.
Wrote online Help content for a mobile application to be rolled out as an extension of the turnkey cloud-hosted application.
Tools
- CMS: WordPress
- Authoring tool: Madcap Flare
- Screenshots: Snagit
- Source control: Github
- Coding: JavaScript & HTML
- Count the number of assets in a domain with the REST API
- Create a workflow to change asset responsibilities
- Hide the Add to Basket button
- Set a default filter in Collibra On-the-Go for Desktop