document-updater
- Repo stars 0
- Author updated Live
- Author repo skills-registry
- Domain
- Documentation
- Compatible agents
-
- Claude Code
- Cursor
- Cline
- Codex
- Windsurf
- Gemini CLI
- +20
- Trust score
- 88 / 100 · community maintained
- Author / version / license
- @tomevault-io · no license declared
- Token usage
- Lean
- Setup complexity
- Guided setup
- External API key
- Not required
- Operating systems
- Unspecified (assume cross-platform)
- Runtime requirements
- No special requirements
- Permissions
-
- Read-only
- Write / modify
- Shell exec
- Env read
- Network behavior
- Local-only
- Install commands
- 26 variants
Profile is derived at build time from SKILL.md and install vectors. Subject to drift from author intent.
Heads up: 未限定 allowed-tools，默认拥有全部工具权限。
---
name: document-updater
description: Updates the README.md file to reflect the current state of the project. Use this skill when the…
category: documentation
runtime: no special runtime
---
# document-updater output preview
## PART A: Task fit
- Use case: Updates the README.md file to reflect the current state of the project. Use this skill when the user says "Update Documentations" or wants to keep the README in sync with GEMINI.md and the actual codebase. Use when this capability is needed..
- Inputs: target material, constraints, expected output, and acceptance criteria.
- Evidence boundary: follow “Workflow / Constraints” and do not present inference as author intent.
## PART B: Execution result
- **01** The card summarizes the use case; runtime output centers on “Updates the README.md file to reflect the current state of the project. Use this skill when the user says "Update Documentations" or wants to keep the README in sync with GEMINI.md and the actual codebase. Use when this capability is needed.”.
- **02** When the source has headings, the agent prioritizes “Workflow / Constraints” so the result follows the author’s structure.
- **03** Typical output includes task judgment, concrete steps, required commands or file edits, validation, and follow-up options.
- **04** Risk context follows the fingerprint: read files, write/modify files, run shell commands, read environment variables; mostly runs locally; usually needs no extra API key.
## Running Rules
- read files, write/modify files, run shell commands, read environment variables; mostly runs locally; usually needs no extra API key.
- Validate with a small sample before expanding scope.
- Return the result, validation criteria, and next iteration options. Choose the trigger
The source does not require a stable slash command. After installation, invoke the skill by name and describe the task.
Provide inputs and boundaries
Name target files or source material, expected output, forbidden changes, and whether network or shell access is allowed. Permission fingerprint: read files, write/modify files, run shell commands, read environment variables.
Validate with a small run
Start with a small task and check whether the result follows “Workflow / Constraints”. Inspect diffs, logs, previews, or tests before expanding scope.
Review before delivery
Confirm the final output includes a concrete result, evidence, and next action. If it stays generic, tighten inputs, boundaries, and acceptance criteria.
---
name: document-updater
description: Updates the README.md file to reflect the current state of the project. Use this skill when the…
category: documentation
source: tomevault-io/skills-registry
---
# document-updater
## When to use
- Updates the README.md file to reflect the current state of the project. Use this skill when the user says "Update Docu…
- Use it when the task has clear inputs, repeatable steps, and validation criteria.
## What to provide
- Target material, scope, expected result, and forbidden changes.
- Whether network, commands, file writes, or external services are allowed.
## Execution rules
- Organize steps around “Workflow / Constraints” and keep inference separate from source facts.
- read files, write/modify files, run shell commands, read environment variables; mostly runs locally; usually needs no extra API key.
- Validate with a small sample before expanding the task.
## Output requirements
- Return the deliverable, key evidence, validation method, and next action.
- Mark missing information as unknown; do not invent commands, platforms, or dependencies. Evidence boundary and execution chain
The author source anchors workflow facts; repository files anchor sources and commands; Fluxly only adds fit, limitations, and quality judgment.
skill "document-updater" {
input -> user goal + target files + boundaries + acceptance criteria
context -> Workflow / Constraints
rules -> SKILL.md triggers / order / output contract
runtime -> no special runtime | read files, write/modify files, run shell commands, read environment variables | mostly runs locally
guardrails -> usually needs no extra API key + small-sample validation + diff/log review
output -> copyable result + checklist + next iteration
}Document Updater
A specialized skill for maintaining and updating the project's README.md file to ensure it accurately reflects the latest architectural decisions, tech stack, features, and setup instructions.
Workflow
Information Gathering:
- Read
GEMINI.mdas the primary source of truth for project context and standards. - Read
package.jsonto verify current dependencies, versions, and scripts. - Read
prisma/schema.prisma(or relevant ORM schema) to confirm the database structure. - Scan the
src/directory if necessary to understand the actual file structure.
- Read
Analysis:
- Compare the current
README.mdwith the gathered information. - Identify outdated sections, incorrect tech stack details, or missing features.
- Ensure that setup instructions (environment variables, commands) are accurate.
- Compare the current
Execution:
- Rewrite or patch
README.mdwith the corrected information. - Maintain a consistent, professional, and concise tone.
- Use clear headings, tables, and code blocks for readability.
- Rewrite or patch
Validation:
- Verify that all links and commands in the updated
README.mdare valid within the project context. - Check for any remaining discrepancies.
- Verify that all links and commands in the updated
Constraints
- Do NOT add "just-in-case" information. Keep it focused on what's actually in the project.
- Follow the existing style and formatting of the
README.md. - Prioritize accuracy over verbosity.
Source: adwaithpj/CardMind — distributed by TomeVault.
Decide Fit First
Design Intent
How To Use It
Boundaries And Review