Skip to content

Journal Entry Schema

YAML Frontmatter Fields

Common Fields (All Entry Types)

Field Type Required Description
type enum Yes decision, learning, activity
date datetime Yes YYYY-MM-DD HH:mm format
tags array Yes 1-5 relevant tags

Decision-Specific Fields

Field Type Required Values
context enum Yes feature, bugfix, refactor, architecture, security, performance
impact enum Yes high, medium, low

Learning-Specific Fields

Field Type Required Values
category enum Yes framework, api, pattern, tool, codebase, language, infrastructure
confidence enum Yes verified, likely, uncertain

Activity-Specific Fields

Field Type Required Values
action enum Yes implemented, investigated, refactored, fixed, configured, documented, tested
scope string Yes Brief description of affected area

File Naming Convention

YYYY-MM-DD-HHmm-{type}.md

Examples: - 2026-01-26-1430-decision.md - 2026-01-26-1445-learning.md - 2026-01-26-1500-activity.md

If multiple entries of same type at same time, append sequence: - 2026-01-26-1430-decision-2.md


Directory Structure

docs/journal/
├── index.md                    # Master index with search hints
├── 2026-01/
│   ├── 2026-01-26-session-summary.md
│   └── entries/
│       ├── 2026-01-26-1430-decision.md
│       └── 2026-01-26-1445-learning.md
└── 2026-02/
    └── ...

Tag Taxonomy

Use consistent tags for searchability:

Technical Domain

api, database, frontend, backend, infrastructure, security, performance, testing

Framework/Tool

rails, typescript, react, postgres, redis, docker, kubernetes

Concern Type

architecture, refactoring, debugging, optimization, migration, integration

Project-Specific

Add project-specific tags as needed, prefix with project name: myapp-auth, myapp-billing