This software user guide documents the Guided Stewardship feature that was newly added to the Collibra Cloud platform application. It combines conceptual and task-oriented topics to explain how Guided Stewardship works.
Process
Writing this guide required a deep understanding of the product. In addition to learning the product through self-exploration and guided training sessions, I spent time interviewing product managers and subject matter experts to better understand how the product works. I also conducted regular meetings with the development team to facilitate the knowledge transfer process, and to get their input on what they thought would be helpful for readers who want more information.
Because the Collibra documentation is published in both HTML and in PDF format, I wrote the content in Madcap Flare, and then generated a PDF file for offline use. This multi-step, single-source solution allowed me to write the content once and publish in different formats.
Tools
- Authoring tool: Madcap Flare
- Screenshots: Snagit
- Source control: Github
- Coding: JavaScript & HTML
View additional live samples from this user guide:
- Guided Stewardship user guide (full user guide)
- Logical Data Layer (selected sample)
- Data Classification Dashboard (selected sample)