Skip to content

Latest commit

 

History

History
272 lines (197 loc) · 9.02 KB

File metadata and controls

272 lines (197 loc) · 9.02 KB

Bitinfrashop Documentation

Complete documentation for the Bitinfrashop Bitcoin marketplace connecting infrastructure providers with shops worldwide


Quick Navigation

For New Team Members

For Developers

For Product/PM


Documentation Structure

This documentation follows the BMAD-METHOD inspired framework: a four-phase approach to product development that emphasizes reflection, collaboration, and systematic thinking.

docs/
├── 01-analysis/              # Understanding & Research
├── 02-planning/              # Strategic Planning
├── 03-solutioning/           # Design & Specification
├── 04-implementation/        # Execution & Tracking
├── workflows/                # Process Documentation
└── tools/                    # Tool-specific guides

Phase 1: Analysis

Purpose: Deeply understand problems before proposing solutions

Problem Statements

Document user pain points with evidence and success metrics.

Research

Ideas

Early-stage concepts and brainstorms.


Phase 2: Planning

Purpose: Prioritize and strategize feature development

Strategic Documents

Architecture Decisions

Why we made key technical choices.

Feature Roadmap

Quarterly planning and feature timeline.


Phase 3: Solutioning

Purpose: Design technical solutions with thorough specifications

Feature Specifications

Detailed design docs for features.

Design Assets

Integrations

Third-party service integration guides.


Phase 4: Implementation

Purpose: Track execution and document progress

Development Journal

Daily/weekly progress logs.

Sprints

Sprint planning and retrospectives.

Backlog

Current tasks and priorities.

Testing

Test reports and quality assurance.

Hackathon 2024

Documentation from Geyser NWC Hackathon win.


Workflows

Purpose: Systematic processes for development activities

Core Workflows

AI & Tools


Tools & Integrations

Claude Code

AI-powered development assistant integration.

AI Agents

Guidelines for working with AI assistants.


Key Documents by Role

Product Manager

  1. Product Vision
  2. Feature Registry
  3. Roadmap
  4. Feature Development Workflow

Software Engineer

  1. AI Agent Guidelines
  2. Architecture Decisions
  3. Feature Specifications
  4. Development Log

Tech Lead/Architect

  1. Architecture Decisions
  2. Feature Development Workflow
  3. Technical Research
  4. ADR Template

Designer

  1. UX Flows
  2. Feature Specifications
  3. User Research

Document Templates

Use these templates to create consistent documentation:


Documentation Standards

Writing Guidelines

  • Clear & Concise: Get to the point quickly
  • Structured: Use headings, lists, and tables
  • Actionable: Include next steps and checklists
  • Dated: Include creation and update dates
  • Linked: Reference related documents

Maintenance

  • Review Cadence: Quarterly for strategic docs, monthly for tactical docs
  • Ownership: Assign document owners
  • Version Control: All docs in git, track changes
  • Archival: Move outdated docs to archive folder

File Naming

  • Use kebab-case: private-server-invitations.md
  • Prefix ADRs with number: ADR-001-description.md
  • Prefix sprints with date: 2025-10-13-sprint-5.md
  • Use _TEMPLATE for templates: _TEMPLATE.md

Contributing to Documentation

Adding a New Feature

  1. Create problem statement in 01-analysis/problem-statements/
  2. Add to feature registry in 02-planning/feature-registry.md
  3. Create specification in 03-solutioning/features/
  4. Follow Feature Development Workflow

Documenting a Decision

  1. Use ADR template from 02-planning/architecture-decisions/ADR-000-template.md
  2. Number sequentially (ADR-001, ADR-002, etc.)
  3. Get team review before marking "Accepted"
  4. Schedule 6-month reflection review

Updating Documentation

  1. Update "Last Updated" date
  2. Note changes in revision history (if applicable)
  3. Update related documents with cross-references
  4. Commit with descriptive message

Related Resources

Root Documentation

External Links


Getting Help

For Documentation Questions

For Technical Questions

See AI Agent Guidelines or Development Log


Last Updated: 2025-10-13 Documentation Framework: Inspired by BMAD-METHOD™ Maintained By: Development Team