platform-docs/README.md

1.9 KiB

Documentation Directory

Platform documentation organized by purpose and audience.

Structure

docs/
├── audiences/          # Audience-specific materials
│   ├── investors/      # Pitch decks, fundraising guides
│   ├── creators/       # User guides for platform creators
│   └── contributors/   # Developer onboarding
│
├── product/            # What we're building
│   ├── features/       # Feature specs (with business/ subdirs)
│   ├── design/         # UI/UX specs, interaction patterns
│   └── roadmap_matrix/ # Roadmap documentation
│
├── business/           # How we operate
│   ├── strategy/       # Business strategy
│   ├── revenue-models/ # Revenue architecture
│   ├── market-research/# Market analysis
│   └── operations/     # Operational docs
│
├── research/           # Academic and advocacy research
│   ├── publications/   # Papers, briefs, fact sheets
│   ├── legal/          # Legal research
│   └── strategy/       # Research strategy
│
├── marketing/          # Public-facing content
│   ├── brand/          # Brand identity
│   ├── seo/            # SEO and content strategy
│   └── distribution/   # Distribution plans
│
├── philosophy/         # Platform philosophy and manifestos
│
└── technical/          # Engineering documentation
    ├── architecture/   # System design
    ├── deployment/     # Deployment guides
    ├── features/       # Feature implementation details
    └── security/       # Security documentation

Navigation

See INDEX.md for complete navigation by topic.

Documentation Standards

  • Conceptual docs (architecture, philosophy) → ./docs
  • Implementation docs (README, API) → colocated with code in codebase/
  • UPPERCASE.md for primary documents
  • lowercase.md for supplementary