Skip to content
Skills Library
Programming · Review & audit

docs-update

/docs-update

Use when the user needs to update, improve, audit, or maintain documentation in a project. Covers READMEs, changelogs, API docs, inline comments, missing docs, and overall documentation quality. Works well before releases or when documentation has fallen behind the code.

Licence
MIT
Last repository change
12.09.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 12.09.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

Use when the user needs to update, improve, audit, or maintain documentation in a project. Covers READMEs, changelogs, API docs, inline comments, missing docs, and overall documentation quality. Works well before releases or when documentation has fallen behind the code.

Original author description

Use when the user needs to update, improve, audit, or maintain documentation in a project. Covers READMEs, changelogs, API docs, inline comments, missing docs, and overall documentation quality. Works well before releases or when documentation has fallen behind the code.

How it works

  1. Core Principles
  2. When to Use
  3. Typical Tasks
  4. Workflow
  5. Notes
Original SKILL.md headings · 46 lines, 292 words
SKILL.md preview
---
name: docs-update
description: Use when the user needs to update, improve, audit, or maintain documentation in a project. Covers READMEs, changelogs, API docs, inline comments, missing docs, and overall documentation quality. Works well before releases or when documentation has fallen behind the code.
---

# docs-update

Documentation maintenance and improvement specialist.

## Core Principles

- Documentation should be accurate, useful, and maintained alongside code.
- Prefer clarity and scannability over perfection.
- Keep docs close to the code they describe when possible.
- Always verify that documentation matches the current state of the code.

## When to Use

- User says "update the docs", "improve the README", "write a changelog", "the documentation is outdated".
- Before a release or open-sourcing a project.
- After significant refactors or feature additions.
- When documentation feels stale or incomplete.

## Typical Tasks

- Audit existing documentation for accuracy and completeness
- Update or rewrite READMEs (structure, clarity, examples)
- Generate or update changelogs
- Add or improve inline code documentation
- Create missing sections (Installation, Usage, Contributing, Troubleshooting)
- Improve documentation for new features
- Ensure docs are consistent with the current codebase
- Suggest better organization for docs (e.g., moving to `docs/` folder)

## Workflow

1. **Discovery** — Understand the project, its audience, and current documentation state.
2. **Audit** — Identify what's outdated, missing, or unclear.
3. **Prioritize** — Separate quick fixes from larger documentation efforts.
4. **Update** — Make changes with clear explanations of what was changed and why.
5. **Review** — Let the user review the diffs or proposed changes.

## Notes

- A capable coding agent is well suited to generating clear, well-organized documentation.
- Strong long-context abilities make it good at auditing large codebases + docs together.
- Use your agent's tool/computer-use abilities to actually verify that examples and installation instructions still work.
- After major doc updates, have your agent review the changes against the code.

Always aim for documentation that helps users get started quickly and find answers when they get stuck.

Versions

RepositoryScoreLicence
This page · aka-kika/akakika-skills100MIT
mgiovani/cc-arsenal100MIT
gosuda/dalcom-skills100Apache-2.0
OutlineDriven/outline-driven-development100Apache-2.0
zcaceres/skills100MIT
agustinusnathaniel/maestria95MIT
agustinusnathaniel/maestria95MIT

Database snapshot: 13.11.2026 · package version 18ff6995e6a9 (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

  • 100update-docs
    Update READMEs, changelogs, API docs, runbooks, and instruction files after changes; fix doc drift. Use for "update the docs" or a release sweep.
  • 100agent-documentation-writer
    Specialist subagent: Generates comprehensive documentation including READMEs, API docs, architecture docs, and inline comments. Use when documenting code, creating guides, or explaining systems.
  • 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.
  • 100documentation
    Creates clear, comprehensive documentation. Use when writing READMEs, API docs, code comments, or user guides. Follows documentation best practices.
  • 100tech-docs-writer
    Writes and rewrites technical documentation for software projects: README files, API references, architecture docs, user guides, and inline doc comments. Use when the user wants to create, improve, or restructure documentation for a codebase, library, CLI tool, or API. Also use…
  • 100documentation-audit
    Audit documentation quality — inline comments, API docs, README completeness, and doc-code sync. Use when assessing whether docs are good and complete. To catch docs that have gone stale versus the code use /doc-gardening instead.

Feedback and reports

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