Writing Guide
Writing Guide
All notes live in _posts/ and are filtered by category (content type). Projects have permanent hubs in _projects/.
Rule of thumb: category = type of note · domain = subject area · project_id = link to a project · tags = technologies and search keywords.
Content types (categories)
| Category | Purpose | Listing | Template |
|---|---|---|---|
blog |
Industry news, opinions, commentary | /writing/ | _templates/blog-post.md |
progress |
Project progress journal | /writing/ | _templates/progress-note.md |
learning |
Guided exercises, coursework, tutorials | /writing/ | _templates/learning-note.md |
explainer |
Deep dive on a concept | /writing/ | _templates/explainer-note.md |
challenge |
Kaggle, ENS, hackathon write-ups | /writing/ | _templates/challenge-note.md |
idea |
Quick future project ideas | /writing/ | _templates/idea-note.md |
reading |
Books, papers, courses | /writing/ | _templates/reading-note.md |
Which category to use?
| You are writing… | Category | Key front matter |
|---|---|---|
| Actu / opinion piece | blog |
domain |
| Project milestone update | progress |
project_id, domain, status, stage |
| Guided exercise (“projet bateau”) | learning |
domain, autonomy: exercise |
| Weekend exploration | learning or progress |
autonomy: little-experiment |
| Future project idea (quick note) | idea |
domain |
| Future project idea (serious) | hub in _projects/ |
status: goal (+ optional idea post) |
| Concept deep dive | explainer |
domain |
| Kaggle / ENS write-up | challenge |
domain, competition |
Shared front matter
Use on any note where relevant (not as categories):
domain— data-science, geospatial, mlops, web-dev, ai-agents, optimization, energy-modelingautonomy— exercise, little-experiment, solo-projectstage— notebook, prototype, mvp, appstatus— goal, wip, done (mainlyprogressand project hubs)project_id— slug linking notes to/projects/your-id/competition— slug grouping challenge posts (e.g.titanic,ens-challenge-2024)
See the Project Taxonomy Guide for field details.
Tags
Technologies and free-form keywords only: Python, PyTorch, Kaggle, time-series. Do not use tags for content type or domain.
Note structures
Blog
Clear sections, link related projects or reading notes.
Progress
- Link to project hub
- What you did
- Next steps
Learning
- Context (course / tutorial source)
- What you did
- Takeaways
Explainer
- Problem
- Intuition
- How it works
- Example
- When to use it
Challenge
- Competition overview
- Approach
- Results
- Lessons learned
Idea
- Motivation
- Rough plan
- Open questions
Reading
- Overview
- Key takeaways
- Practical applications
- Recommendations