Documentation & Best Practices Flashcards

Which practice best keeps data pipeline documentation synchronized with code changes?

Answer: Storing documentation alongside code in version control and requiring updates in pull requests

Docs-as-code ties documentation changes to code reviews so they evolve together.

What is an Architecture Decision Record (ADR) used for?

Answer: Capturing a significant design decision along with its context, options considered, and consequences

ADRs preserve the reasoning behind architectural choices so future teams understand why decisions were made.

A data contract between a producer and consumer team typically documents which of the following?

Answer: Schema, semantics, quality expectations, and service levels for a dataset

Data contracts formalize schema, meaning, quality, and SLA commitments to prevent breaking changes.

Which document records how long each category of records must be kept and when it should be disposed of?

Answer: Records retention schedule

A retention schedule specifies retention periods and disposition actions based on legal and business requirements.

In a RACI matrix for data governance, what does the 'A' role signify?

Answer: Accountable - the single person who owns the outcome and signs off

The Accountable party has ultimate ownership and there should be only one per task.

Which framework is widely referenced as the body of knowledge for data management practices, including metadata and documentation?

Answer: DAMA-DMBOK

DAMA-DMBOK defines data management knowledge areas such as governance, metadata, and data quality.

What does 'datasheets for datasets' documentation primarily aim to improve in AI/ML projects?

Answer: Transparency about a dataset's motivation, composition, collection process, and recommended uses

Datasheets for datasets document provenance and limitations so users can judge fitness for purpose and bias risks.