cleanup-and-review-docs

Clean and review AI-generated documentation in the docs directory.

Updated Feb 10, 2026
One-click install
npx skills add https://github.com/jrodrigopuca/skills --skill cleanup-and-review-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: cleanup-and-review-docs
Source: https://github.com/jrodrigopuca/skills/tree/main/create-software-docs/sub-skills/cleanup-and-review-docs
Command: npx skills add https://github.com/jrodrigopuca/skills --skill cleanup-and-review-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill refines AI-generated documentation, ensuring it's clear, consistent, and ready for delivery by addressing editorial issues without altering factual content.

Core Features & Use Cases

  • Editorial Cleanup: Removes duplication, normalizes formatting, and improves readability.
  • Placeholder Removal: Cleans up leftover placeholders and marks unresolved items.
  • Consistency Check: Aligns terminology and fixes minor cross-link issues.
  • Use Case: After an AI generates a set of technical documents, use this Skill to ensure all headings are consistent, repetitive sentences are condensed, and any "[TBD]" markers are either resolved or clearly flagged for follow-up.

Quick Start

Run the cleanup-and-review-docs skill on the generated documentation files in the 'docs/' directory.

Frequently Asked Questions about cleanup-and-review-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I clean up AI-generated documentation for consistency and readability?

To clean up AI-generated documentation, apply an editorial review process that removes duplication, normalizes formatting, and aligns terminology without altering factual content. This refines text for clarity and consistency, ensuring final delivery quality.

What is the best way to remove placeholders and unresolved markers from technical docs?

The best way to remove placeholders from technical docs is using a targeted cleanup process that eliminates leftover markers like "[TBD]". Unresolved items are either resolved or clearly flagged for follow-up to ensure the documentation is delivery-ready.

Can I review and fix editorial consistency in a specific docs directory?

Yes, you can review and fix editorial consistency in a specific docs directory. The cleanup process applies directly to the `{scope}/docs/` directory, aligning terminology and fixing minor cross-link issues to ensure uniform formatting across all files.

Do I need validated files and quality checklists before starting an editorial cleanup?

Yes, you need validated files, validation findings, and quality checklists before starting the editorial cleanup. These inputs guide the refinement process to ensure the review addresses actual issues without inventing new facts or altering technical content.

What are the limitations of using an editorial cleanup process on AI-generated content?

An editorial cleanup process for AI-generated content is limited to refining consistency, readability, and formatting without inventing new facts. It does not generate new documentation or validate technical accuracy, serving strictly to polish existing validated files for final delivery.