Files
blackroad-os-archive/docs/ARCHIVE_COVER_SHEET_TEMPLATE.md
2025-11-24 04:32:13 -06:00

1.0 KiB
Raw Permalink Blame History

Archive Cover Sheet Template

Use this template (also generated by scripts/gen_cover_skeletons.ts) for every repo or project that needs archival coverage.

---
id: example-repo
title: Example Repo
type: repo
status: active
timeframe: 2025-
primary_repo: example-repo
linked_repos: []
summary: TODO
why_it_matters: TODO
risk_if_lost: TODO
recommended_action: keep-live
---

# Example Repo  Archive Cover Sheet

## Narrative
TODO

## History
TODO

## Current Role
TODO

## Dependencies
TODO

## Migration / Future
TODO

Writing guidance

  • Narrative: Describe what the project is and who uses it.
  • History: Capture why it was created and any major shifts or rewrites.
  • Current Role: Explain how it fits the constellation today (deps, clients, surfaces).
  • Why it matters: Spell out the unique value so stakeholders know why to keep it healthy.
  • Risk if lost: List what would break or become slower/harder to rebuild.
  • Recommended action: Choose from keep-live, snapshot, deprecate, merge and note any blocking steps.