Skip to content
Skills Library
Programming · Review & audit

refresh-documentation

/refresh-documentation

Review and update all project documentation to keep it accurate and current. Use this skill when asked to refresh, update, or audit documentation, README files, AGENTS.md files, skill descriptions, or any markdown docs across the codebase.

Repository
codebase ↗
Licence
MIT
Last repository change
26.10.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
1
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 26.10.2026, without references to retired models or APIs.

Licence

MIT, open: use and modify while retaining author attribution.

What it does and when to use it

Review and update all project documentation to keep it accurate and current. Use this skill when asked to refresh, update, or audit documentation, README files, AGENTS.md files, skill descriptions, or any markdown docs across the codebase.

Original author description

Review and update all project documentation to keep it accurate and current. Use this skill when asked to refresh, update, or audit documentation, README files, AGENTS.md files, skill descriptions, or any markdown docs across the codebase.

How it works

  1. When to Use This Skill
  2. Scope
  3. Step-by-Step Workflow
  4. References
Original SKILL.md headings · 56 lines, 396 words
SKILL.md preview
---
name: refresh-documentation
description: Review and update all project documentation to keep it accurate and current. Use this skill when asked to refresh, update, or audit documentation, README files, AGENTS.md files, skill descriptions, or any markdown docs across the codebase.
license: MIT
---

# Refresh Documentation

This skill guides a systematic review and refresh of all documentation across the codebase. It is also invoked automatically each week by the `refresh-documentation` GitHub Actions workflow, which creates a GitHub issue assigned to Copilot.

## When to Use This Skill

- When asked to "refresh documentation", "update docs", or "audit documentation"
- When documentation may be stale after significant code changes
- On the weekly scheduled cadence (triggered automatically via GitHub issue)

## Scope

Documentation to review and update:

| Path                         | Description                                                          |
| ---------------------------- | -------------------------------------------------------------------- |
| `README.md`                  | Root codebase README                                                 |
| `documentation/**/*.md`      | Core documentation files                                             |
| `AGENTS.md`                  | Workspace-level Copilot instructions — skill table must stay in sync |
| `*/AGENTS.md`                | Per-project Copilot instructions                                     |
| `*/README.md`                | Project README files                                                 |
| `.github/skills/**/SKILL.md` | Skill files (mirrored to `documentation/skills/`)                    |

## Step-by-Step Workflow

### Phase 1 — Audit

For each path in scope, read the documentation and cross-check it against the actual codebase. Classify every finding into one of three categories:

| Category       | Criteria                                                                               | Action                              |
| -------------- | -------------------------------------------------------------------------------------- | ----------------------------------- |
| **Deprecated** | Documents a feature, command, file, or API that no longer exists                       | **Remove** the section or file      |
| **Outdated**   | Content exists but is inaccurate — wrong path, outdated command, incorrect description | **Update** to match current reality |
| **Missing**    | A feature, project, convention, or workflow exists in the codebase but is undocumented | **Create** new documentation        |

### Phase 2 — Act

1. **Remove deprecated content** — Delete sections, files, or entries that document things that no longer exist. This includes dead links, removed commands, retired projects, and superseded conventions.

2. **Update outdated content** — Fix inaccurate content by cross-checking against actual source files:
   - Code examples: verify commands, file paths, and APIs against the codebase
   - README files: check that project structure, commands, and purpose are accurate
   - AGENTS.md files: verify quick-reference commands still work and descriptions match current conventions
   - Cross-references: fix broken internal links

3. **Create missing documentation** — Write new content for undocumented areas:
   - New projects added since the last documentation refresh
   - New conventions, tools, or workflows not yet documented
   - Features documented in code comments but absent from markdown docs

## References

- [AGENTS.md](../../../AGENTS.md) — Workspace-level instructions
- [documentation/](../../../documentation/) — Core documentation directory

Versions

The database has no other skills named refresh-documentation.

Database snapshot: 13.11.2026 · package version e324c4b47e65 (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 100md-docs
    Manages project documentation: AGENTS.md, README.md, and CONTRIBUTING.md. Use when asked to "update README", "update agents", "init agents", "create AGENTS.md", "update AGENTS.md", "update CONTRIBUTING", "update context files", or "init context". Not for general markdown editing.
  • 100code-documentation
    Analyze source code repositories and create, update, and validate accurate technical documentation. Use when developers request README generation, API documentation, architecture documentation, codebase explanation, or documentation maintenance.
  • 90update-project
    Use when updating docs, syncing AGENTS.md, CLAUDE.md, or README.md, fixing stale documentation, or refreshing project rules and skills. Keeps docs aligned with code changes.
  • 100documentation
    Use this skill when the user asks you to write, update, or fix project documentation — READMEs, API docs, user guides, ADRs, or other Markdown docs. Also use when code changes need user-facing docs updates. Only write Markdown files; do not use for implementation, planning or test work.
  • 95readme
    When the user wants to create or update a README.md file for a project. Also use when the user says 'write readme,' 'create readme,' 'document this project,' 'project documentation,' or asks for he...
  • 100docs-update
    Audit project documentation against the current state of the codebase and produce a revision plan. Reads README and all docs, launches parallel Explore agents to verify claims, diffs documentation vs reality, and applies approved fixes. Use when user says "quality-docs-update",…

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.