Skip to content

Template

Copy the template below into a file called chronicl.md at the root of your project and start filling it out.

Getting started

You don't need to fill every section at once. Start with Overview, Motivation/Objectives, and Tech Stack, then build up the rest as your project evolves.


## CODEBASE OVERVIEW

## MOTIVATION/ OBJECTIVES

## TECH STACK

## CONTRIBUTORS

## DESIGN DECISIONS

## RISKS

## OPEN ENDED

## NEXT STEPS

## NOTES

## JOURNAL

Section Guide

Section What to put here
Codebase Overview High-level project structure and purpose — one paragraph max
Motivation/Objectives Numbered list of goals (MO1, MO2…). What problem are you solving?
Tech Stack Key libraries, services, and dependencies with brief rationale
Contributors Team members and their roles
Design Decisions Why you chose this architecture, those trade-offs, that library
Risks Known challenges and your mitigation strategies
Open Ended Unresolved questions and ideas under consideration
Next Steps Immediate priorities and short-term roadmap
Notes Ad-hoc insights from meetings, discussions, and coding sessions
Journal Dated entries (e.g. @username DD.MM.YY) for each branch/feature/fix

Journal Format

## JOURNAL

@username 14.07.25
- Implemented user authentication flow
- Decided on JWT over sessions due to stateless requirements (DC3)
- Discovered edge case with token refresh — added to Risks (R4)

Reference other sections with their codes (e.g. DC3, R4) to keep entries linked to decisions.