Knowledge Portal · engineering documentation

Skip to content

Product Documentation Template

Status: Template · Copy to PRODUCTS/PRD-xxx-name.md


markdown
# PRD-XXX — Product Name

**Status:** Proposed | Official | Deprecated
**Owner:** Product engineering
**Repository:** `org/repo`
**Baseline tag:** `vX.Y-name`
**Last updated:** YYYY-MM-DD

---

## Overview

Business purpose in one paragraph.

## Business purpose

Who uses it, what outcome it delivers.

## Architecture

```mermaid
flowchart TB
    subgraph Product["PRD-XXX"]
        M1[Module A]
        M2[Module B]
    end
    PL003[PL-003] --> M1
    PL004[PL-004] --> M2

Modules

ModulePurposeDoc

Index: MODULES/README.md

Platforms consumed

PlatformUsage

Capabilities

Product-registered capabilities (not platform internals).

Database

Schema ownership per module.

Events

Published and subscribed events.

Agent

Primary agent(s): AGENTS/

UI

Filament / Blade / public surfaces.

Integrations

External systems, federation exports.

Deployment

Environments, config, .env keys (index only — no secrets).

Configuration

Link: REFERENCE/environment-variables.md

Roadmap

Link: ROADMAPS/

Known limitations

Future work

Home → Products → PRD-XXX

ZAIXOS Knowledge Portal — public engineering docs at /docs · Staff operations at /admin