classify-docs

分类: 工具与效率 | 上传者: BlueEventHorizon | 下载: 0 | 版本: v1.0（最新）

Auto-detect and classify project document directories as rules or specs. Updates config.yaml root_dirs based on classification results.

更新日志: Source: GitHub https://github.com/BlueEventHorizon/DocAdvisor-CC

目录结构

当前层级: .claude/skills/classify-docs/

📄 SKILL.md 4.0 KB

SKILL.md

---
name: classify-docs
description: |
  Auto-detect and classify project document directories as rules or specs.
  Updates config.yaml root_dirs based on classification results.
  Trigger:
  - After initial setup to configure document directories
  - "Classify my documents"
  - "What directories should be rules vs specs?"
allowed-tools: Bash, Read, Edit
user-invocable: true
argument-hint: "[--update]"
doc-advisor-version-xK9XmQ: 4.1
---

# classify-docs

Auto-detect and classify project document directories for Doc Advisor.

## Usage

```
/classify-docs [--update]
```

| Argument | Description |
|----------|-------------|
| (none) | Full classification of all markdown directories |
| `--update` | Only process directories not already in config.yaml root_dirs |

## Prerequisite

config.yaml must exist at `.claude/doc-advisor/config.yaml`.
If not, run `setup.sh` first.

## Reference Documents

Before classifying, read the classification rules:
- `.claude/doc-advisor/docs/classification_rules.md`

This document defines:
- **category**: rules / specs
- **doc_type**: rule, requirement, design, plan, api, reference, spec
- Judgment procedure (path components → frontmatter → file content)

## Execution Flow

### Step 1: Run directory scan script

```bash
$HOME/.pyenv/shims/python3 .claude/doc-advisor/scripts/classify_dirs.py
```

Capture the JSON output. The script discovers markdown directories but does NOT classify them.

### Step 2: Classify using rules

For each discovered directory in the JSON output:

1. Read `classification_rules.md` rules
2. Apply path_components scan (top-down, first match wins)
3. Check frontmatter doc_types if path is ambiguous
4. If still unclear, read 1-2 .md files from the directory

Assign each directory a **category** (rules/specs) and note confidence:
- **high**: path component directly matches (e.g., `rules/`, `specs/requirements/`)
- **medium**: semantic match or frontmatter match
- **low**: inferred from file content

### Step 3: Present results to user

Display the classification results clearly:

```
Document Directory Classification

Rules (development rules, guidelines, standards):
  [high] rules/           (3 files)
  [medium] guidelines/    (2 files)

Specs (requirements, designs, plans):
  [high] specs/           (5 files)
  [medium] design/        (2 files)

Skipped:
  docs/                   README/CHANGELOG only

Unclassified:
  shared/                 (3 files) - need user input
```

### Step 4: Ask user for confirmation

Ask the user:
- Are the classifications correct?
- For unclassified directories: should they be rules, specs, or skipped?
- Any overrides needed?

### Step 5: Update config.yaml

After user confirmation, update `.claude/doc-advisor/config.yaml` using the Edit tool.

Replace the commented `root_dirs` and `doc_types_map` lines with actual values:

```yaml
# Before:
rules:
  # root_dirs: []    # Auto-configured by setup.sh or /classify-docs
  # doc_types_map: {}  # Path-to-doc_type mapping (auto-configured)

# After:
rules:
  root_dirs:
    - rules/
    - guidelines/
  doc_types_map:
    rules/: rule
    guidelines/: rule
```

For specs, map each directory to its specific doc_type:

```yaml
specs:
  root_dirs:
    - specs/requirements/
    - specs/design/
  doc_types_map:
    specs/requirements/: requirement
    specs/design/: design
```

Valid doc_types: `rule`, `requirement`, `design`, `plan`, `api`, `reference`, `spec`

**Important**: If root_dirs is already uncommented (from a previous run), replace the existing list and doc_types_map.

### Step 6: Summary

```
config.yaml updated

Rules directories:
  - rules/
  - guidelines/

Specs directories:
  - specs/
  - design/

Next steps:
  - /create-rules-toc --full  (generate rules search index)
  - /create-specs-toc --full  (generate specs search index)
```

## Error Handling

- If config.yaml doesn't exist, tell user to run setup.sh first
- If no markdown directories found, report that the project has no documents to classify
- If classification script fails, report the error and suggest manual configuration

登录后下载/点赞/收藏 ❤ 2 | ★ 0

classify-docs

目录结构

SKILL.md

举报内容

提示