Preface: Immuta Documentation
Site Design and Structure
The structure of technical documentation among enterprises is vastly diverse and inconsistent, making the navigation of these sites cumbersome for users. To contend with these challenges at Immuta, we designed our documentation to accommodate various audiences and leave room for the growth of our product; therefore, we did not organize our content by product-centric features or user personas. Instead, we chose a structure that is recognizable, one that most are already familiar with: narrative.
The Table of Contents provides an outline of each chapter, and the succession of each is designed around the narrative of the customer journey and the processes that journey entails: installing, configuring, and implementing Immuta.
Additionally, each chapter contains an introductory page that establishes context for that particular stage in the process, and, as you work through that process, narrative use cases establish context for specific features, explaining not only what a feature does, but why (and how) you should use it. Consequently, rather than becoming a conglomeration of suggestions, tips, and tutorials, our documentation reflects our best practices and the processes users should follow.
Data privacy issues and breaches aren’t isolated, disparate incidents, no more than Immuta is a collection of disparate features; they’re part of a much larger story, a global narrative -- one that involves massive amounts of data collection, sharing, and analysis. The organization of our documentation reflects that continuity.