documentation-project-scan

Scan documentation folders and classify artifacts into canonical, orphan, or duplicate.

Updated Jan 6, 2026

Search Tags:#documentation #analysis #reporting #backlog #inventory #scan #gaps

Ready to run

npx skills add https://github.com/cslsoftwares/ParamentersORM --skill documentation-project-scan

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-project-scan
Source: https://github.com/cslsoftwares/ParamentersORM/tree/main/.cursor/skills/documentation-project-scan_V1.1.0
Command: npx skills add https://github.com/cslsoftwares/ParamentersORM --skill documentation-project-scan

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill scans the project's documentation ecosystem to discover artefacts and gaps using naming and folder patterns, and outputs an inventory, a classification, and an actionable backlog. It treats Documentation/ as canonical root and includes legacy Docs/docs in the root until consolidation.

Core Features & Use Cases

Inventory canonical and orphan docs across Documentation/, Docs/ and docs/ with status tags.
Classify artifacts (canonical, superseded, orphan, duplicated) and generate backlog items for gaps or improvements.
Produce a conflict report when multiple sources compete for canonical destination.

Quick Start

Run the scan from the repository root to inventory Documentation artifacts and surface gaps.

Frequently Asked Questions about documentation-project-scan

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

FAQPage Schema

How do I inventory documentation artifacts and find gaps across multiple folders?▼

To inventory documentation artifacts and find gaps, scan the repository root to classify files across Documentation/, Docs/, and docs/ folders, generating an actionable backlog of missing or orphaned items.

How do I identify duplicate and orphaned markdown files in my project?▼

Identify duplicate and orphaned files by scanning folder patterns to classify artifacts as canonical, superseded, orphan, or duplicated, surfacing conflicts when multiple sources compete for the canonical destination.

What is a documentation backlog and how is it generated from a scan?▼

A documentation backlog is an actionable list of gaps and improvements generated by scanning and classifying artifacts across legacy Docs/docs and canonical Documentation/ root folders, treating the root as the primary source until consolidation.

Can I detect documentation conflicts when consolidating multiple folder directories?▼

Yes, you can detect documentation conflicts during consolidation by producing a conflict report that identifies multiple sources competing for the same canonical destination within the Documentation/ ecosystem.

What's the best way to scan legacy Docs and docs folders without deleting them?▼

The best way to scan legacy folders without deletion is to inventory and classify items with status tags, treating Documentation/ as canonical while including legacy Docs/docs in the root until full consolidation is complete.

Why does my documentation inventory show files as orphaned instead of canonical?▼

Files appear as orphaned instead of canonical when naming and folder pattern analysis determines they do not belong to the established Documentation/ root structure, classifying them separately for backlog resolution.