Home / Companies / dltHub / Blog / Post Details
Content Deep Dive

The role of docs in data products

Blog post from dltHub

Post Details
Company
Date Published
Author
Adrian Brudaru
Word Count
1,267
Language
English
Hacker News Points
-
Summary

A data product is a self-contained piece of data-powered software that serves a single use case, serving as an integral part of the company and their product. It requires consideration of the use case, technical stack, and documentation to enable usage by others. A data product consists of structured data, code, and user manuals, which are essential for usability and trustworthiness. The importance of documentation is highlighted, with top-level documents explaining the purpose and "why", as well as more detailed guides on each component. Effective documentation follows standard formats, such as learning-oriented tutorials, goal-oriented how-to guides, understanding-oriented discussions, and information-oriented reference material. By considering these components and their interconnectivity, developers can create high-quality data products that meet user needs and expectations.