Files
projectmycelium/docs/dev/method/current/design_method.md
2025-09-01 21:37:01 -04:00

1.2 KiB

Project Mycelium Dev Method

Overview

This documentation is for developers. Keep the architecture clear and iterate pragmatically. Update this document and the architecture with each meaningful change.

  • Architecture & Roadmap (authoritative): docs/dev/design/current/projectmycelium-roadmap.md
  • Ops deployment method: docs/ops/method/current/deployment_method.md

Artifacts

  • Architecture & Roadmap (single source of truth for design, status, troubleshooting)
  • TODO board/list capturing concrete steps to production
  • Decision Log (mini-ADRs) for key trade-offs under docs/dev/decisions/ (optional)

Working Mode

  • Small PRs tied to issues; fast iteration and feedback
  • Keep TODO and architecture updated as the project evolves
  • Schedule regular refactoring and documentation touch-ups

TODO Item Template

Title: <concise goal>
Context: <current state and reason>
Change: <what will be done>
Acceptance: <clear criteria/tests>
Links: <issue/PR/related docs>

Decision Record Template (ADR)

Title: <decision>
Context: <why we need a decision>
Options: <considered options>
Decision: <chosen option>
Consequences: <trade-offs and follow-ups>