index

Hollowgate - Design Documentation

Welcome to the Hollowgate game design documentation vault! This is your central hub for all design decisions, proposals, and game design documentation.

What’s Inside

Architecture Decision Records (ADRs)

📁 ADRs

ADRs document important architectural and technical decisions. Use these to:

• Record why we chose certain technologies or approaches
• Understand historical context of our architecture
• Avoid revisiting settled decisions
• Help new team members understand our technical direction

README.md

Request for Comments (RFCs)

📁 RFCs

RFCs are design proposals for new features and systems. Use these to:

• Propose new game features and mechanics
• Gather team feedback before implementation
• Explore design alternatives
• Create shared understanding of complex systems

README.md

Templates

📁 Templates

Ready-to-use templates for creating new documents:

• ADR-Template.md - For architecture decisions
• RFC-Template.md - For feature proposals

Quick Start Guide

Creating Your First ADR

1. Copy ADR-Template.md
2. Name it: ADRs/ADR-XXX-your-title.md
3. Fill in all sections
4. Update the index in README.md
5. Commit to git

Creating Your First RFC

1. Copy RFC-Template.md
2. Name it: RFCs/RFC-XXX-your-title.md
3. Fill in all sections
4. Share with team for review
5. Update the index in README.md
6. When finalized, create a corresponding ADR

Workflow

Idea/Problem
    ↓
Create RFC (for discussion)
    ↓
Team Review & Iteration
    ↓
Decision Made
    ↓
Create ADR (for record)
    ↓
Implementation

Best Practices

When to Write an ADR

• Choosing technologies or frameworks
• Significant architectural changes
• Technical approach decisions
• Tool selections
• Performance optimization strategies

When to Write an RFC

• New game features or mechanics
• Major system designs
• Gameplay changes
• UI/UX improvements
• Content architecture

Writing Tips

• Be specific - Provide enough detail for implementation
• Consider alternatives - Show you’ve explored options
• Link related docs - Connect ADRs and RFCs
• Update regularly - Keep documents current
• Use visuals - Diagrams help understanding
• Tag appropriately - Use consistent tags for searching

Tags & Organization

Common Tags

• #gameplay - Game mechanics and systems
• #technical - Technical architecture
• #ui-ux - User interface and experience
• #performance - Optimization and performance
• #multiplayer - Online features
• #tools - Development tools and workflow
• #narrative - Story and quests
• #graphics - Visual design
• #audio - Sound and music
• #ai - Enemy and NPC behavior

Using Obsidian

This vault is designed for Obsidian, which provides:

• Bidirectional links - Link between related documents
• Graph view - Visualize document relationships
• Tags - Organize and search by category
• Templates - Quick document creation
• Search - Fast full-text search

Useful Obsidian Features

• [[Document Name]] - Link to other documents
• #tag - Tag documents for organization
• Ctrl/Cmd + P - Command palette
• Ctrl/Cmd + O - Quick file switcher
• Graph view - See how documents relate

Contributing

All team members are encouraged to:

1. Propose RFCs for new ideas
2. Comment on existing RFCs
3. Document decisions as ADRs
4. Keep documentation up to date
5. Link related documents
6. Use consistent formatting

Questions?

• New to ADRs? Read ADR-001-example.md
• New to RFCs? Read RFC-001-example.md
• Need help? Ask the team!

---

Last Updated: 2025-12-02 Vault Version: 1.0