project-doc-tracker
Project Doc Tracker
Use this skill to maintain a lightweight project memory inside the repository.
Prefer this skill when the user asks things like:
- "Record this project update for me."
- "Show me where this project currently stands."
- "Add a short status note for this feature."
- "Help me save the current state so we do not forget it later."
- "Initialize a tracker for this project."
- "Backfill tracker docs for an existing codebase."
Workflow
1. Collect evidence before writing
Before updating tracker docs, inspect the most relevant evidence available:
git statusand, when useful,git diff --stator a focused diff- recently modified files
- relevant
.kiro/specs/documents - the user's latest goal or instruction
Do not write high-confidence progress notes if evidence is weak. When needed, record a cautious summary and mark confidence as low.
2. Choose the right mode
Use one of these modes:
init: initialize tracker docs only. Createdocs/project-tracker/and, when the repo already has code, backfill the initial overview and feature notes from existing evidencelog: append a structured session update after a meaningful changesync-item: merge one feature into the active item table and update keyed next-step or blocker bullets inOVERVIEW.mdfeature-note: create or update a stable feature note for one topicpromote-to-doc: hand off a completed or stable feature to$professional-markdownfor a full formal documentstatus: read the overview and the most recent progress entries to restore context
Use slug-like feature_id values such as memory-system or project_doc_tracker. Do not use spaces, slashes, .., or other path-like fragments.
Here, "initialize" means initializing the tracker documentation system, not project bootstrap, dependency install, runtime setup, or test setup.
3. Prefer the helper script for deterministic writes
Use scripts/project_tracker.py for file creation and updates instead of hand-editing tracker Markdown whenever practical.
Script path:
D:\openGuiclaw\.agents\skills\project-doc-tracker\scripts\project_tracker.py
Do not use the helper script to generate long-form formal module documentation. That content should be written directly with $professional-markdown.
4. Promote mature features into formal docs
When a feature becomes done, stable, or is clearly important enough for long-term maintenance:
- read the relevant tracker note, progress history, specs, and source files
- decide the target formal doc location, usually
docs/modules/<name>.mdunless the user wants another docs area - invoke the
professional-markdownskill to produce the long-form document - update the tracker note and overview row with the formal doc path
If a feature already has a formal doc path recorded, ordinary sync-item updates should preserve that link unless you are explicitly changing it.
Use this mode for both:
- single completed features
- batch documentation passes over multiple mature modules
5. Keep the tracker conservative
The tracker is a memory aid, not a source of fabricated truth.
- record what changed
- link the change to evidence when possible
- record blockers explicitly
- record the next step explicitly
- use
lowconfidence when you are inferring rather than observing
6. Treat history as append-only
PROGRESS.md is an audit-style log. Do not delete or silently rewrite old entries. If you need to correct a previous note, append a new correction entry.
Tracker Layout
Default project-local storage:
docs/project-tracker/
├─ OVERVIEW.md
├─ PROGRESS.md
└─ features/
└─ <feature-id>.md
Read references/tracker-format.md when you need the exact document structure or marker names.
Read references/workflow.md when you need the step-by-step operating procedure.
Read references/prompt-examples.md when you want ready-to-use prompt templates for initialization, daily updates, recovery, or promote-to-doc flows.
Practical Rules
- When the user asks to "initialize" this skill, interpret it as "initialize tracker docs" unless they explicitly ask for runtime or bootstrap work.
- Do not auto-edit
AGENTS.md,CLAUDE.md,.cursorrules, or similar rule files by default. - Do not dump raw repo state into the tracker; summarize it.
- Do not create duplicate feature notes when a stable file for the same feature already exists.
- Do not try to force formal docs into
docs/project-tracker/features/; keep those notes lightweight. - When generating formal documentation, reuse
$professional-markdowninstead of extendingproject_tracker.py. - When the user wants continuous follow-up, explain that the skill can be paired with automation, but the skill alone is not a scheduler.
- If the repo already contains meaningful code, do not leave the freshly initialized tracker mostly empty; scan the codebase and backfill the initial
OVERVIEW.md, key feature notes, and formal-doc candidates. - For Kiro users, installation of the skill does not automatically create
.kiro/steering/project-doc-tracker.md. Usescripts/setup_kiro_steering.pyto install it into a target project, or fall back toreferences/steering-template.mdfor manual copy.