mirror of
https://github.com/profullstack/logicsrc.git
synced 2026-08-13 14:37:26 +00:00
feat(openprd): publish the OpenPRD standard
OpenPRD is a lightweight, single-file PRD standard (prd/<slug>/prd.md) for humans and AI agents — the low-ceremony counterpart to OpenSpec's multi-file change bundles. PRD documents are private by convention; only the standard is published here. - docs/openprd.md — the standard: file layout, front-matter, the 8 required body sections, privacy, and the optional bridge to LogicSRC tasks. - packages/schemas/schemas/openprd-prd.schema.json — front-matter manifest schema. - packages/schemas/fixtures/openprd-prd.yaml — a valid manifest fixture. - packages/validators — register the openprd-prd schema. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
parent
d76dd498f2
commit
1d7887485a
4 changed files with 178 additions and 1 deletions
104
docs/openprd.md
Normal file
104
docs/openprd.md
Normal file
|
|
@ -0,0 +1,104 @@
|
|||
# OpenPRD
|
||||
|
||||
OpenPRD is a lightweight, open standard for **product requirements documents** authored by humans or AI agents. It is maintained by Profullstack, Inc. as part of the LogicSRC open-standards surface.
|
||||
|
||||
Where [OpenSpec](./openspec-comparison.md) models a *change* as a multi-file bundle (proposal + design + specs + tasks + deltas), OpenPRD deliberately models a *product decision* as **one Markdown file**. It answers "what are we building and why", not "how the change is structured for implementation". The single-file shape is the point: it is the low-ceremony front door that a `prd` CLI command can produce in one step.
|
||||
|
||||
## Privacy
|
||||
|
||||
**PRD documents are private by convention.** Only this standard is published. Generated PRDs live under a repo-local `prd/` directory that SHOULD be listed in `.gitignore`. Tools that write OpenPRD documents MUST NOT publish them anywhere by default.
|
||||
|
||||
## File layout
|
||||
|
||||
```txt
|
||||
prd/
|
||||
<slug>/
|
||||
prd.md # one OpenPRD document (front-matter manifest + body)
|
||||
```
|
||||
|
||||
- `<slug>` is a kebab-case identifier, unique within the repo, and equal to the manifest `id`.
|
||||
- A repo MAY contain many PRDs; each is a self-contained directory so attachments (mockups, notes) can sit beside `prd.md`.
|
||||
|
||||
## Manifest (front-matter)
|
||||
|
||||
Every `prd.md` opens with a YAML front-matter block validated by
|
||||
[`openprd-prd.schema.json`](../packages/schemas/schemas/openprd-prd.schema.json):
|
||||
|
||||
```yaml
|
||||
---
|
||||
openprd: "0.1" # standard version (required)
|
||||
id: park-service-expansion # kebab-case slug == directory name (required)
|
||||
title: Parked-domain service expansion # (required)
|
||||
status: draft # draft | review | active | shipped | archived (required)
|
||||
owner: did:key:… # optional DID/handle of the accountable owner
|
||||
repo: moshcoder/moshcoding # optional target repo (owner/name)
|
||||
created: 2026-07-12 # optional ISO date
|
||||
updated: 2026-07-12 # optional ISO date
|
||||
tags: [growth, monetization] # optional labels
|
||||
supersedes: [old-slug] # optional ids this PRD replaces
|
||||
---
|
||||
```
|
||||
|
||||
## Body sections
|
||||
|
||||
The body is Markdown with a fixed, ordered set of `##` sections. All are required (a section MAY be a single line such as `_None._`), which keeps every PRD skimmable and diffable:
|
||||
|
||||
1. `## Problem` — the user/business problem, and why it matters now.
|
||||
2. `## Goals` — what success looks like, as outcomes (not features).
|
||||
3. `## Non-Goals` — explicitly out of scope, to bound the work.
|
||||
4. `## Users` — who this is for; personas or segments.
|
||||
5. `## Requirements` — numbered `R1`, `R2`, … each prefixed with a priority tag `[P0]`/`[P1]`/`[P2]`. One capability per line.
|
||||
6. `## UX Notes` — flows, states, and constraints that shape the experience.
|
||||
7. `## Success Metrics` — how the goals will be measured.
|
||||
8. `## Risks & Open Questions` — known risks and decisions still owed.
|
||||
|
||||
### Minimal example
|
||||
|
||||
```markdown
|
||||
---
|
||||
openprd: "0.1"
|
||||
id: launch-flip
|
||||
title: Coming-soon → live launch flip
|
||||
status: draft
|
||||
---
|
||||
|
||||
## Problem
|
||||
Parked domains have no one-click path from coming-soon to a live site.
|
||||
|
||||
## Goals
|
||||
Owners flip a domain live and notify its waitlist in a single action.
|
||||
|
||||
## Non-Goals
|
||||
_Building the live site itself._
|
||||
|
||||
## Users
|
||||
Domain owners running parked pages on the service.
|
||||
|
||||
## Requirements
|
||||
- R1 [P0] A per-domain "go live" action publishes/redirects the domain.
|
||||
- R2 [P0] Flipping live emails that domain's waitlist.
|
||||
- R3 [P1] The action is reversible within a grace window.
|
||||
|
||||
## UX Notes
|
||||
One button on the domain's admin row; confirm dialog shows the waitlist size.
|
||||
|
||||
## Success Metrics
|
||||
Time-to-live per domain; waitlist → visit conversion after launch.
|
||||
|
||||
## Risks & Open Questions
|
||||
- Email deliverability on bulk launch sends.
|
||||
- Should redirects preserve `?dn=` analytics?
|
||||
```
|
||||
|
||||
## Relationship to LogicSRC
|
||||
|
||||
OpenPRD is intentionally decoupled from the rest of LogicSRC: a PRD is just a file and needs no service to exist. When coordination is wanted, a PRD's `Requirements` map cleanly onto LogicSRC `task` documents (each `R#` → one task), and the PRD `owner`/`repo` reuse LogicSRC identity and repo conventions. That bridge is optional and lives in tooling, not in this standard.
|
||||
|
||||
## Conformance
|
||||
|
||||
A document conforms to OpenPRD `0.1` when:
|
||||
|
||||
- it lives at `prd/<slug>/prd.md`,
|
||||
- its front-matter validates against `openprd-prd.schema.json`,
|
||||
- `id` equals `<slug>`, and
|
||||
- all eight body sections are present in order.
|
||||
10
packages/schemas/fixtures/openprd-prd.yaml
Normal file
10
packages/schemas/fixtures/openprd-prd.yaml
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
openprd: "0.1"
|
||||
id: park-service-expansion
|
||||
title: Parked-domain service expansion
|
||||
status: draft
|
||||
owner: moshcoder.coinpay
|
||||
repo: moshcoder/moshcoding
|
||||
created: 2026-07-12
|
||||
tags:
|
||||
- growth
|
||||
- monetization
|
||||
61
packages/schemas/schemas/openprd-prd.schema.json
Normal file
61
packages/schemas/schemas/openprd-prd.schema.json
Normal file
|
|
@ -0,0 +1,61 @@
|
|||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://schemas.logicsrc.com/openprd-prd.schema.json",
|
||||
"title": "OpenPRD Product Requirements Document",
|
||||
"description": "The front-matter manifest of an OpenPRD document. OpenPRD is a deliberately lightweight, single-file PRD standard: one prd/<slug>/prd.md per product decision, authored by a human or an AI agent. The document body is Markdown with a fixed set of sections; this schema governs only the YAML front-matter. PRD documents are private by convention (gitignored) — only the OpenPRD standard itself is published.",
|
||||
"type": "object",
|
||||
"required": ["openprd", "id", "title", "status"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"openprd": {
|
||||
"type": "string",
|
||||
"pattern": "^\\d+\\.\\d+(\\.\\d+)?$",
|
||||
"description": "OpenPRD standard version this document conforms to, e.g. '0.1'."
|
||||
},
|
||||
"id": {
|
||||
"type": "string",
|
||||
"pattern": "^[a-z0-9][a-z0-9-]*$",
|
||||
"description": "Kebab-case slug, unique within the repo. Also the directory name: prd/<id>/prd.md."
|
||||
},
|
||||
"title": {
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
"description": "Human-readable product/feature title."
|
||||
},
|
||||
"status": {
|
||||
"type": "string",
|
||||
"enum": ["draft", "review", "active", "shipped", "archived"],
|
||||
"description": "Lifecycle stage of the PRD."
|
||||
},
|
||||
"owner": {
|
||||
"type": "string",
|
||||
"description": "Optional DID or handle of the accountable owner, e.g. a LogicSRC agent or account DID."
|
||||
},
|
||||
"repo": {
|
||||
"type": "string",
|
||||
"description": "Optional owner/name of the repository this PRD targets."
|
||||
},
|
||||
"created": {
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"description": "ISO date (YYYY-MM-DD) the PRD was created."
|
||||
},
|
||||
"updated": {
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"description": "ISO date (YYYY-MM-DD) of the last substantive edit."
|
||||
},
|
||||
"tags": {
|
||||
"type": "array",
|
||||
"items": { "type": "string" },
|
||||
"uniqueItems": true,
|
||||
"description": "Optional freeform labels for grouping PRDs."
|
||||
},
|
||||
"supersedes": {
|
||||
"type": "array",
|
||||
"items": { "type": "string", "pattern": "^[a-z0-9][a-z0-9-]*$" },
|
||||
"uniqueItems": true,
|
||||
"description": "Optional ids of earlier PRDs this one replaces."
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -22,6 +22,7 @@ import credentialProviderSchema from "../../schemas/schemas/logicsrc-credential-
|
|||
import credentialSyncPlanSchema from "../../schemas/schemas/logicsrc-credential-sync-plan.schema.json" with { type: "json" };
|
||||
import credentialSyncRunSchema from "../../schemas/schemas/logicsrc-credential-sync-run.schema.json" with { type: "json" };
|
||||
import credentialAuditEventSchema from "../../schemas/schemas/logicsrc-credential-audit-event.schema.json" with { type: "json" };
|
||||
import openprdPrdSchema from "../../schemas/schemas/openprd-prd.schema.json" with { type: "json" };
|
||||
|
||||
export const schemas = {
|
||||
agent: agentSchema,
|
||||
|
|
@ -47,7 +48,8 @@ export const schemas = {
|
|||
"credential-provider": credentialProviderSchema,
|
||||
"credential-sync-plan": credentialSyncPlanSchema,
|
||||
"credential-sync-run": credentialSyncRunSchema,
|
||||
"credential-audit-event": credentialAuditEventSchema
|
||||
"credential-audit-event": credentialAuditEventSchema,
|
||||
"openprd-prd": openprdPrdSchema
|
||||
} as const;
|
||||
|
||||
export type SchemaKind = keyof typeof schemas;
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue