shard-wiki/spec/ProductRequirementsDocument.md

56 lines
1.8 KiB
Markdown
Raw Normal View History

# ProductRequirementsDocument
Status: **draft scaffold** · Date: 2026-06-08
See InfoTechPrimers on coulomb.social for PRD conventions.
## 1. Product Name
**shard-wiki**
## 2. Product Intent
Git-based Markdown wiki **orchestrator and federation layer** — not a wiki
engine. Joins heterogeneous wiki-shaped page stores (shards) into a coherent
information space while preserving provenance, capabilities, and history.
Authoritative aspiration: `INTENT.md`.
## 3. Problem Statement
Wiki content lives in fragmented backends (Git repos, Gitea wikis, local
folders, Obsidian vaults, WebDAV, application databases). Users and tools need a
union of pages with versionable coordination, overlays for remote edits, and
explicit provenance — without forcing a single storage format or engine.
## 4. Target Users
See `INTENT.md` § Intended Users.
## 5. Core Capabilities (maturity target)
- Attach multiple shards to a shared root entity.
- Present union views of pages, links, metadata, and revisions.
- Lazy projection and cache of remote shard content.
- Overlay-before-mutation for capability-limited shards.
- Git-backed coordination journal per information space.
- Capability-aware shard adapter contract.
- Pluggable authorization from open (L0) through multi-tenant enterprise (L4).
- Complete recoverable history as the baseline safety net.
## 6. Non-Goals
See `INTENT.md` § Strategic Boundaries.
## 7. Research Inputs
- `research/260608-yawex-prior-art/findings.md` — federation design seeds from
prior art.
- `research/260608-federation-concepts/findings.md` — Federated Wiki, git/AP
federation models; UC-26UC-33 in `spec/UseCaseCatalog.md`.
## 8. Open Items
Pending completion of `SHARD-WP-0001` and `SHARD-WP-0002` design tasks and
ratification of access model INTENT amendments. Detailed requirements will be
expanded as spec tasks complete.