02-documentation-workflow

A rule set for building software around written project documents. It assigns separate documents to topics such as goals, system design, engineering decisions, plans, progress, and operating procedures.

In plain words
What is it for?
Use it to organize project documentation, guide implementation from written plans, record important decisions, and maintain an engineering history.
Why use it?
It keeps project knowledge in one agreed location and makes the intended design clear before implementation begins.

Cursor rule for Cursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/pueraeternis/agentic-project-template/02-documentation-workflow
Clone the repo
git clone --depth 1 https://github.com/pueraeternis/agentic-project-template

Made for: Cursor.

Per session 678 This file is loaded in full into every session.
When invoked 678 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00678 $0.00678
Opus 5 $0.00339 $0.00339
Sonnet 5 $0.00136 $0.00136
Haiku 4.5 $0.00068 $0.00068

Measured 2d ago against content hash dbe58c5c06d3, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

02-documentation-workflow scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.cursor/rules/02-documentation-workflow.mdc · 176 lines

How it starts

The opening of the file, as written. The whole thing — 176 lines — stays where its author put it; the contents beside it link to each section on GitHub.


Documentation Workflow

Documentation is the primary engineering artifact.

Implementation follows documented intent.

Permanent project knowledge must be recorded in the repository.


Documentation Responsibilities

Each document has a single responsibility.

Document Responsibility
PROJECT.md Project vision, goals, scope and MVP
ROADMAP.md Long-term implementation strategy
ARCHITECTURE.md System organization and architectural boundaries
ENGINEERING.md Engineering decisions, tooling and project conventions
ADRs Significant architectural decisions
Plans Authorized implementation increments
PROGRESS.md Completed engineering history
RUNBOOK.md Operational procedures

Avoid duplicating information across documents.

Every piece of knowledge should have one authoritative location.


Documentation Lifecycle

Project knowledge matures through the following lifecycle:

Idea
        ↓
PROJECT.md
        ↓
ROADMAP.md
        ↓
ARCHITECTURE.md
        ↓
ENGINEERING.md
        ↓
Repository Initialization
        ↓
Implementation Plan
        ↓
Implementation
        ↓
Code Review
        ↓
PROGRESS.md

Architecture decisions should be recorded as ADRs whenever appropriate.


Documentation Updates

Update documentation whenever:

  • project goals change;
  • roadmap changes;
  • architecture changes;
  • engineering decisions change;
  • repository structure changes;
  • operational procedures change;
  • new durable project knowledge appears.

Do not leave important decisions only in chat history.


Engineering Decisions

ENGINEERING.md records project-specific engineering decisions.

Read the full file on GitHub · 176 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 176 lines · 678 tokens per session scan A dbe58c5c06d3

Subscribe to this mod's changes

02-documentation-workflow is a cursor rule published in the GitHub repository pueraeternis/agentic-project-template (2 stars, last pushed 2mo ago), licensed MIT. It adds 678 tokens to every session, about $0.0034 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.