Skip to content
cccskills
FreePublished on GitHub

docs-refactor

Refactor a whole documentation page in this repository without losing source-verified behavior facts. Use for page rewrites, splits, reorganizations, or substantial shortening of README sections, docs pages, or instruction files. Do not use for ordinary documentation authoring, targeted corrections, or documentation review; use technical-documentation instead.

The English summary is being prepared. Showing the original description.

See how to install

Files included (1)

  • SKILL.md3.7 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

Documentation Refactor

Read technical-documentation first. A rewrite improves structure; it is never permission to discard behavior facts.

Operating contract

ConcernRule
Use whenRewriting, splitting, merging, reorganizing, or materially shortening a README section, docs\*.md page, or root or scoped AGENTS.md file.
Do not use whenWriting a new page, making a targeted documentation correction, or reviewing documentation without a whole-page restructuring; use technical-documentation.
Required inputsTarget page or section, desired reader outcome, intended page type, and the authority for every behavior-sensitive claim.
Mutation boundaryInventory the old content before editing. Give every fact exactly one outcome: keep, move to a named destination, or delete with source-backed proof of obsolescence.
Done whenThe fact inventory is reconciled, old and new content are compared, sources and links are validated, and the final report names every moved fact and destination.

Refactor workflow

  1. Read ..\technical-documentation\SKILL.md and its repository-surface authority table. Limit page types to README sections, docs\*.md pages, and instruction files; select the appropriate tutorial, how-to, reference, or explanation shape before editing.
  2. Build a pre-rewrite fact inventory from the current target: commands, flags, defaults, prerequisites, constraints, safety notes, errors, recovery steps, examples, expected output, links, and ownership claims.
  3. Assign every inventory item exactly one outcome: keep in the target, move to one named existing or new destination, or delete only when the designated source authority proves it obsolete or out of scope. Do not leave an outcome implicit.
  4. Verify behavior-sensitive facts against the authorities in ..\technical-documentation\references\repo-surfaces.md. Never infer current behavior from the old prose, a name, a default, or intent.
  5. Draft around the reader funnel: orient the reader, present one recommended path, give an observable check, then route detailed, rare, or reference material without burying task-critical safety information.
  6. Preserve or repair cross-surface consistency. For instruction files, README.md, CONTRIBUTING.md, root and scoped AGENTS.md files, and docs\*.md must agree with each other and source according to their distinct audiences.
  7. Perform an old-versus-new comparison. Reconcile each fact-inventory row, every command, warning, link, and moved destination before declaring the refactor complete.
  8. Run the applicable real commands from ..\technical-documentation\references\repo-surfaces.md, including the advisory doc-reference check when it is available. Report the exact validation command(s) run, result, and lanes not run.

Final report

Name the target, its selected page type, the source authorities checked, and each fact moved with its exact destination. Explicitly list facts deleted and the proof of obsolescence, unresolved uncertainty, validation performed, and validation lanes not run.

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

deslop

Free

Perform a diff-scoped, behavior-neutral cleanup of AI-generated slop on the current branch before code review. Use for removing trivial comment, defensive-check, type-laundering, redundant-intermediate, compatibility-shim, or local style drift from the branch diff. Do not use for full correctness or safety review, documentation work handled by technical-documentation or docs-refactor, or repo-wide refactors.

The English summary is being prepared. Showing the original description.

openclaw/openclaw-windows-packaging4Updated Oct 17, 2026

Write, review, or audit this repository's technical documentation, including README.md, CONTRIBUTING.md, root and scoped AGENTS.md files, docs pages, and documentation drift. Use for source-backed documentation authoring, behavior verification, and cross-surface consistency. Do not use for code review, deslop diff cleanup, or whole-page rewrites, splits, or reorganizations handled by docs-refactor.

The English summary is being prepared. Showing the original description.

openclaw/openclaw-windows-packaging4Updated Oct 17, 2026

Handle user-facing GUI, sign-in, and file handoffs from an isolated Windows agent session; not ordinary headless work.

The English summary is being prepared. Showing the original description.

openclaw/openclaw-windows-packaging4Updated Oct 17, 2026

See all skills by openclaw

Report a problem with this skill