Agent skill

Update Project Doc

by flonat in flonat/flonat-research

Update a project's own CLAUDE.md, README.md, or docs/ to reflect current state.

MITAuto-check passedAgent Workflows

Install Update Project Doc

skills CLI
$ npx skills add flonat/flonat-research --skill update-project-doc -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install flonat/flonat-research update-project-doc --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/flonat/flonat-research.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/update-project-doc .claude/skills/update-project-doc && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
update-project-doc
GitHub stars
145
Token cost
~2.4k tokens
SKILL.md length
1,097 words
Files
1
Skills in repo
83
Repo updated
First seen
Licence
MIT

At a glance

Update a project's own CLAUDE.md, README.md, or docs/ to reflect current state.

  • Works in 6 steps: Detect Documentation Files → Gather Current State → Run Staleness Checks → …
  • The user asks to update a projects own CLAUDE.md
  • SKILL.md covers When to Use, What It Does NOT Do, Protocol and Key Rules, plus 1 more section
  • Calls git and vault

What it does

Update Project Doc is an agent skill from flonat/flonat-research. Update a project's own CLAUDE.md, README.md, or docs/ to reflect current state. Use when the user asks to update a project's own CLAUDE.md, README.md, or docs/ to reflect current state.

Its SKILL.md is about 2.4k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Agent Workflows, covering Agent instruction files and Technical documentation. The repository describes itself as: Shareable Claude Code + Codex infrastructure for PhD researchers — skills, agents, hooks, and rules for academic workflows. The licence is MIT.

When your agent uses it

  • The user asks to update a projects own CLAUDE.md
  • Docs/ to reflect current state

Example prompts

  • “/update-project-doc”

Requirements

  • Pre-approved tools (allowed-tools): Read, Edit, Write, Glob, Grep, Bash(ls*), Bash(git log*), Bash(git diff*), Bash(readlink*), Bash(wc*), Bash(date*), AskUserQuestion

Workflow steps

6 steps, taken from the step headings in SKILL.md.

  1. Detect Documentation Files
  2. Gather Current State
  3. Run Staleness Checks
  4. Propose Changes
  5. Ask for Confirmation
  6. Apply and Report

What it can do on your machine

Read from SKILL.md and the folder at commit da27600. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves these tools, so the agent can use them without asking each time:

    • Read
    • Edit
    • Write
    • Glob
    • Grep
    • Bash(ls*)
    • Bash(git log*)
    • Bash(git diff*)
    • Bash(readlink*)
    • Bash(wc*)

    …and 2 more on the same allowed-tools line.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • git
    • vault

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use git, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Update Project Doc loads about 2.4k tokens when it runs. Until then it costs about 51 tokens; SKILL.md has 1,097 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~51
When it runs · the whole SKILL.md, loaded when a task matches
~2.4k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from flonat/flonat-research at commit da27600, republished under its MIT licence (© flonat). 1,097 words, ~2,410 tokens.

Download SKILL.mdSave it as .claude/skills/update-project-doc/SKILL.md (or your agent's skills folder).
name
update-project-doc
description
Update a project's own CLAUDE.md, README.md, or docs/ to reflect current state. Use when the user asks to update a project's own CLAUDE.md, README.md, or docs/ to reflect current state.
allowed-tools
Read, Edit, Write, Glob, Grep, Bash(ls*), Bash(git log*), Bash(git diff*), Bash(readlink*), Bash(wc*), Bash(date*), AskUserQuestion
argument-hint
(no arguments)

Update Project Doc — Refresh Stale Documentation

Scan a project's documentation files and update sections that have drifted from reality: file trees, timestamps, bibliography counts, next steps, skill/hook tallies, and more.

When to Use

  • After significant project work (new files, completed milestones, structural changes)
  • During session-close when offered
  • When the user says "update project docs", "refresh docs", "sync my docs", "update my README"
  • Periodically to keep documentation accurate

What It Does NOT Do

  • Never rewrites research content (hypotheses, arguments, literature, design decisions)
  • Never deletes sections — only updates factual/structural content within existing sections
  • Never creates new documentation files — only updates existing ones

Protocol

Step 1: Detect Documentation Files

Find all documentation files in the project:

  1. Check for CLAUDE.md in project root
  2. Check for README.md in project root
  3. Scan docs/ and docs/*/ for .md files containing file trees or counts
  4. Note which files exist — only update what's present

Special case: Some projects (e.g., the political information paper) have no CLAUDE.md because they use a committed README.md as their primary project documentation instead. This is intentional for repos meant to be shared or published. In these cases, treat README.md as the main documentation file and apply all the same checks to it.

Read each detected file to understand its current content.

Step 2: Gather Current State

Collect the actual state of the project:

  1. File tree — use ls -R or Glob to build the actual directory structure (respect .gitignore patterns, skip out/, __pycache__/, .venv/, node_modules/)
  2. Recent git history — git log --oneline -20 for recent commits
  3. Session logs — read the latest 1-2 files in log/ (if the directory exists)
  4. Bibliography count — count entries in any .bib file(s): grep -c '@' *.bib
  5. Symlink targets — readlink on any documented symlinks
  6. Context files — read .context/current-focus.md or .context/project-recap.md if present

Task Management only (detected by presence of skills/ directory): 7. Skill count — count directories in skills/ that contain SKILL.md 8. Hook count — count .sh files in hooks/ (if present) 9. Skill lengths — wc -l skills/*/SKILL.md to identify bloated skills

Leanness data (all projects): 10. CLAUDE.md line count — wc -l CLAUDE.md 11. CLAUDE.md section sizes — count lines per ## section 12. README.md line count — wc -l README.md 13. SKILL.md line counts — (Task Management only) wc -l skills/*/SKILL.md 14. Duplication scan — check if CLAUDE.md content duplicates what's already in README.md, docs/, or .context/ files 15. Agent line counts — wc -l .claude/agents/*.md (if present) 16. Context file line counts — wc -l .context/*.md (if present)

Step 3: Run Staleness Checks

Compare gathered state against documented content. Flag any mismatches:

CheckHow to Detect
File treeGenerate actual tree, compare against any tree/structure block in docs (look for ``` blocks or indented listings with file paths)
TimestampsFlag "Last updated", "w/c", or date stamps older than 7 days
Bibliography countCompare actual .bib entry count vs any documented count (e.g., "42 references")
Next steps / roadmapCross-reference items against recent commits and session logs — flag items that appear completed
Manuscript statusFlag sections marked "TODO", "incomplete", or "placeholder" that now have content
SymlinksVerify documented symlink targets still resolve with readlink
Skill/hook counts(Task Management only) Compare actual count vs documented numbers in CLAUDE.md, README.md, and .tex files
Venue/target infoIf CLAUDE.md documents a target journal, check it matches .context/projects/_index.md (if accessible)
Step 3b: Leanness Audit

Using the data gathered in Step 2 (items 10-14), check infrastructure file sizes against thresholds. This applies to all projects, not just Task Management.

FileThresholdWhat to flagFix
CLAUDE.md or AGENTS.mdExceeds the lean-guidance-files budgetCurrent line and word countExtract reference sections to docs/, replace with pointers
CLAUDE.md sectionsAny ## section > 15 lines of reference materialSection name + line countExtract to docs/ with a one-line summary + link
CLAUDE.md duplicationContent duplicated from README/docs/.contextWhich content is duplicated and whereKeep only the pointer in CLAUDE.md
README.md> 300 lines totalCurrent line countExtract long sections to docs/
SKILL.md files> 300 lines each (TM only)File name + line countMove templates/examples/report formats to references/ or templates/ subdirectory
Project agents (.claude/agents/*.md)> 400 lines eachFile name + line countExtract verbose prompt sections to companion files
Context files (.context/*.md)> 200 lines eachFile name + line countArchive stale content, keep current

What counts as "reference material" (extractable): assessment guidelines, detailed literature notes, long examples, report templates, checklists, reviewer feedback.

What does NOT count (keep in place): safety rules, conventions, folder structure trees, session continuity pointers.

Present leanness findings separately from staleness findings in Step 4.

Show full SKILL.md (354 more words)Show less
Step 4: Propose Changes

Present findings grouped by file:

Staleness report for [Project Name]:

CLAUDE.md:
  - File structure tree is outdated (missing: X, Y; removed: Z)
  - Skill count says 23, actual is 26
  - "Last updated" date is 3 weeks old

README.md:
  - Directory structure block needs updating
  - Next steps: "Write introduction" appears completed (commit abc1234)
  - Bibliography count says 38, actual is 42

docs/overview.md:
  - No issues detected

Leanness:
  - CLAUDE.md: 237 lines (threshold: 200) — ## Assessment section is 42 lines of guidelines
  - README.md: OK (189 lines)

If nothing is stale, report that and stop.

Step 5: Ask for Confirmation
Step 5a: Staleness Fixes

Use the available structured-question mechanism to let the user approve, modify, or skip staleness fixes:

  • Apply all — update everything proposed
  • Select by file — choose which files to update
  • Skip — make no changes
Step 5b: Offer Leanness Fixes

If Step 3b found leanness issues, present each as an individually actionable item:

Leanness fixes available:

| # | File | Issue | Current | Fix |
|---|------|-------|---------|-----|
| 1 | CLAUDE.md | >200 lines | 237 | Extract ## Assessment section → docs/ |
| 2 | skills/X/SKILL.md | >300 lines | 382 | Move checklists → references/ |

Use the available structured-question mechanism with multiSelect: true:

  • Question: "Which leanness fixes do you want to apply?"
  • One option per fix with current size and proposed outcome
  • Include an "All of them" option as the first choice

Do not defer or merely report leanness findings. Always present them as actionable items alongside staleness fixes.

Step 6: Apply and Report

For each approved change:

  1. Use targeted Edit operations — never rewrite entire files
  2. Preserve all surrounding content
  3. When updating file trees, match the existing formatting style (├──, |--, indented, etc.)
  4. When updating counts, find the exact number and replace it
  5. When marking next-step items as done, use strikethrough (item) rather than deleting

After all edits, print a summary:

Updated project docs:
  CLAUDE.md:  file tree, skill count (23 → 26)
  README.md:  directory structure, bib count (38 → 42), 1 next-step marked complete
  Total: 5 edits across 2 files

Key Rules

  1. Targeted edits only — never rewrite entire files. Use Edit with precise old_string / new_string.
  2. Preserve research content — hypotheses, questions, literature reviews, design decisions, and arguments are sacred. Only update factual/structural sections.
  3. Always show before applying — never make silent edits. The proposal step is mandatory.
  4. Match existing style — if the project uses ├── trees, don't switch to |--. If counts use "X total", don't change to "X skills".
  5. Works in any project — not just Task Management. Adapt checks to what's present.
  6. Idempotent — running twice in a row should produce no changes the second time.

Cross-References

  • session-close — offers to run this skill at Step 3.5
  • sync-repo private — Task Management-specific superset: propagates counts across all private TM docs including LaTeX files. Run after this skill when in the TM project.
  • vault sync (edit vault files directly) — syncs state to the central context library (complementary; run after this)
  • update-focus — updates current-focus.md (different purpose: session state, not doc accuracy)

© flonat, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in skills/update-project-doc of flonat/flonat-research.

Open the folder on GitHubat commit da27600

Compare with similar skills

Update Project Doc next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Update Project Doc compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Update Project Doc this skillflonat/flonat-research145—~2.4kAutomated safety check: PassMIT
Neat-Freak Knowledge CloseoutKKKKhazix/khazix-skills21k—~1.9kAutomated safety check: PassMIT
Dsh Web Documentationzhu1090093659/dsh-web8.5k—~479Automated safety check: PassApache-2.0
Newprojectscunning1975/MixtapeTools4701 repos~850Automated safety check: PassNone
Sync Public DocsCaldis/react-zmage946—~3.3kAutomated safety check: PassMIT
Review DocsKaggle/kaggle-environments454—~2.7kAutomated safety check: PassApache-2.0

Similar skills

  • Neat-Freak Knowledge Closeout

    KKKKhazix/khazix-skills

    Brings project docs, agent rule files, authorized memory and leftover workspace files back in line with what the code and runtime actually do at the end of a work session.

    21k GitHub stars~1.9k tokensUpdated 7 days ago
    Agent WorkflowsAuto-check passed
  • Dsh Web Documentation

    zhu1090093659/dsh-web

    A skill your agent uses when adding or editing dsh-web README files, docs, AGENTS.md instructions, user-facing configuration text, or bilingual documentation pairs.

    8.5k GitHub stars~479 tokensUpdated today
    Agent WorkflowsAuto-check passed
  • Newproject

    scunning1975/MixtapeTools

    Scaffold a new research project with standard directory structure, CLAUDE.md template, and documented README.

    470 GitHub starsUsed in 1 repo~850 tokens
    Agent WorkflowsAuto-check passed
  • Sync Public Docs

    Caldis/react-zmage

    A skill your agent uses when modifying public API in packages/core (types/global.ts, types/default.ts, index.ts, or package.json exports field), adding/renaming/removing props, changing default…

    946 GitHub stars~3.3k tokensUpdated 4 mo ago
    Agent WorkflowsAuto-check passed
  • Review Docs

    Kaggle/kaggle-environments

    Audit a game environment's README.md and AGENTS.md against its engine implementation.

    454 GitHub stars~2.7k tokensUpdated today
    Agent WorkflowsAuto-check passed
  • Documentation

    samchon/typia

    Defines README, website-guide, and agent-instruction structure, audience, prose formatting, and voice for typia.

    5.9k GitHub stars~1.1k tokensUpdated 2 days ago
    Agent WorkflowsAuto-check passed

More from flonat/flonat-research

All 83 skills in this repo
  • Latex Posters

    flonat/flonat-research

    Create a large-format academic poster in LaTeX using beamerposter, tikzposter, or baposter.

    145 GitHub stars~1.5k tokensUpdated 9 days ago
    Auto-check: notes
  • Skill Creator

    flonat/flonat-research

    Create, revise, and evaluate reusable AI workflow skills, including trigger-quality tests.

    145 GitHub stars~4.4k tokensUpdated 9 days ago
    Auto-check passed
  • DOCX

    flonat/flonat-research

    Create, read, edit, or convert Microsoft Word documents while preserving professional document structure.

    145 GitHub stars~1.2k tokensUpdated 9 days ago
    Auto-check passed
  • PDF

    flonat/flonat-research

    Read, create, combine, split, rotate, OCR, watermark, secure, or extract content from PDF files.

    145 GitHub stars~488 tokensUpdated 9 days ago
    Auto-check passed
  • Init Project Orchestration

    flonat/flonat-research

    Create or migrate project-level agents, repeatable project workflows, and planning state from one client-neutral contract, then render repository-scoped adapters for both Claude Code and Codex.

    145 GitHub stars~1.6k tokensUpdated 9 days ago
    Auto-check passed
  • Pre Commit Audit

    flonat/flonat-research

    Deliver a fast pre-commit safety scan: file size, anonymity (author / affiliation strings in tex/bib), hardcoded secrets, and invisible-Unicode carriers.

    145 GitHub stars~2.8k tokensUpdated 9 days ago
    Auto-check: notes

Questions about Update Project Doc

What does Update Project Doc do?

Update a project's own CLAUDE.md, README.md, or docs/ to reflect current state. Update Project Doc is an agent skill from flonat/flonat-research.md, or docs/ to reflect current state.

When should I use Update Project Doc?

Update Project Doc fits situations like: the user asks to update a projects own CLAUDE.md; docs/ to reflect current state.

How do I install Update Project Doc in Claude Code?

Run `npx skills add flonat/flonat-research --skill update-project-doc -a claude-code`. Or copy the skill folder (skills/update-project-doc in flonat/flonat-research) into .claude/skills/update-project-doc in your project. Claude Code loads it when a task matches its description.

How do I install Update Project Doc in Codex?

Run `npx skills add flonat/flonat-research --skill update-project-doc -a codex`. Or copy the skill folder (skills/update-project-doc in flonat/flonat-research) into .agents/skills/update-project-doc in your project. Codex loads it when a task matches its description.

Can I use Update Project Doc in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add flonat/flonat-research --skill update-project-doc -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/update-project-doc, .gemini/skills/update-project-doc, .github/skills/update-project-doc and .opencode/skills/update-project-doc in your project.

What does Update Project Doc need to run?

Going by SKILL.md and its folder, Update Project Doc needs the command-line tools its instructions call (git and vault). Its frontmatter pre-approves these tools: Read, Edit, Write, Glob, Grep, Bash(ls*), Bash(git log*), Bash(git diff*), Bash(readlink*), Bash(wc*), Bash(date*), AskUserQuestion.

Does Update Project Doc access the network?

SKILL.md contains no URLs. Its commands use git, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Update Project Doc safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Update Project Doc use?

Update Project Doc is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Update Project Doc use?

About 2.4k tokens (SKILL.md is roughly 9.6k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Update Project Doc?

Skills that share tags, products or a category with Update Project Doc: Neat-Freak Knowledge Closeout (KKKKhazix/khazix-skills, 21k stars), Dsh Web Documentation (zhu1090093659/dsh-web, 8.5k stars), Newproject (scunning1975/MixtapeTools, 470 stars) and Sync Public Docs (Caldis/react-zmage, 946 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Update Project Doc?

flonat (a GitHub user) maintains it in flonat/flonat-research, which has 145 GitHub stars. The repository holds 83 skills in this directory. The repository was last updated on September 29, 2026.

Source: flonat/flonat-research on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.