| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
| Name | Name | Last commit date | ||
|---|---|---|---|---|
Standards and patterns shared across kphutt repositories.
Every repository follows the same documentation structure:
ROADMAP.md # root — prioritized big rocks
docs/
decisions/
0001-short-title.md # one decision per file
0002-short-title.md
design/
{initiative}/
brainstorm.md # required scratchpad per initiative
Lifecycle: Roadmap item → brainstorm → decisions → code
The PM view. Prioritized list of what's next. This is the backlog — no separate backlog file. Items are big rocks (features, refactors, architectural changes). Mark completed items with strikethrough and checkmark.
One file per decision, numbered sequentially (0001, 0002, ...). Append-only — never edit after writing. If a decision is reversed, write a new record that supersedes it.
# Short title (verb phrase)
## Status
Accepted | Superseded by 0042
## Context
What's the situation? What forces are at play? Value-neutral facts.
## Decision
What did we decide? "We will..." in active voice.
## Consequences
What follows from this — good, bad, and neutral.Required for every initiative. Dump sub-tasks, open questions, half-baked ideas, trade-off analysis before building. Messy by design. When something settles, it graduates to a decision record in docs/decisions/.
Every repo has an AGENTS.md at its root — the tool-agnostic (agents.md) entry point that AI coding assistants read: build commands, architecture overview, key patterns, testing notes, and a pointer to the docs structure.
Not a substitute for README.md. The README is for humans browsing GitHub. AGENTS.md is for AI coding assistants that need to understand the codebase fast.
Imperative mood, present tense. First line is a concise summary (under 72 characters). The subject describes the change, not the file.
Examples:
No conventional-commits prefix (feat:, fix:) — just clear English.
| Back | FazBrowse Home | New Git URL |