The Quick Reference Guide for Microdata Archivists is a practical resource designed to support the documentation, preservation, discovery, access, and reuse of microdata and related research data assets. The guide reflects internationally recognized good practices in data curation, metadata management, and digital preservation.
Intended for microdata archivists, data curators, metadata specialists, repository administrators, and data stewards, the guide provides concise, standards-based guidance for managing data and metadata throughout the data lifecycle.
The guide aims to:
- Provide practical guidance for common archiving and curation activities.
- Promote the consistent application of metadata standards, including the Data Documentation Initiative (DDI).
- Support data quality, discoverability, interoperability, preservation, and responsible data sharing.
- Document recommended workflows, procedures, and best practices for managing microdata collections.
- Serve as a reference resource for institutions responsible for preserving and disseminating research data.
This repository contains the source code and documentation content used to build and publish the Quick Reference Guide for Microdata Archivists.
The documentation site is built with VitePress and serves as the authoritative source for maintaining, reviewing, and publishing guide content.
Repository contents include:
- Markdown source files for guide content.
- VitePress configuration and site assets.
- Templates, examples, and reference materials.
- Build and deployment scripts.
- Version-controlled documentation used to generate published outputs.
npm install
npm run docs:devThe dev server starts at http://localhost:5173.
Windows:
build-all.batOr from command line:
npm run build:allThis generates:
- HTML Documentation →
docs/.vitepress/dist/ - PDF Guide →
docs/public/Guide-for-Data-Archivists.pdf - Combined Markdown →
docs/public/guide-combined.md
If you need to run specific tasks:
npm run docs:build # Build HTML only
npm run guide:pdf # Generate PDF only
npm run guide:combine # Create combined markdown only
npm run guide:print # Create print-friendly HTML onlynpm run docs:previewStarts a preview server at http://localhost:4173.
docs/
├── .vitepress/
│ └── config.ts # Site configuration and navigation
├── public/
│ └── media/ # Guide images
├── index.md # Home page
└── *.md # Guide chapters
microdata[at]worldbank.org
This project is licensed under the MIT License together with the World Bank IGO Rider. The Rider is purely procedural: it reserves all privileges and immunities enjoyed by the World Bank, without adding restrictions to the MIT permissions. Please review both files before using, distributing or contributing.