Skip to content
Back to skills

Doc Maintain

ASecurity

Maintain documentation (sync, cleanup, update)

  • 666 stars
  • 0 votes
  • 0 copies
  • 3 views
  • Added February 8, 2026
documentationbashdocumentation

Security analysis

A100/100

Scanned February 12, 2026

npx -y skills add majiayu000/claude-skill-registry --skill doc-maintain --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Doc Maintain?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Doc Maintain
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/majiayu000-doc-maintain/badge)](https://www.skillsdirectory.com/skills/majiayu000-doc-maintain)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
name: doc-maintain
description: Maintain documentation (sync, cleanup, update)
user-invocable: true
allowed-tools: Skill, Read, Write, Edit, Glob, Grep, Bash
---

# Documentation Maintain Skill

Maintenance operations for existing documentation: sync with code, cleanup stale content, refresh metadata.

## Parameters

- **action** (required): sync|cleanup|update
- **target** (optional): File or directory (default: current directory)

## Workflow

### Step 1: Parse Parameters

```
If action not provided OR action not in [sync, cleanup, update]:
  Show usage and exit
```

**Usage:**
```
/doc-maintain action=<action> [target=<path>]

Parameters:
  action - Required: sync|cleanup|update
  target - Optional: File or directory (default: .)

Actions:
  sync    - Sync documentation with code changes
  cleanup - Remove stale/duplicate documentation
  update  - Refresh metadata and cross-references

Examples:
  /doc-maintain action=update
  /doc-maintain action=sync target=standards/
  /doc-maintain action=cleanup target=docs/
  /doc-maintain action=update target=README.adoc
```

### Step 2: Validate Target

```
If target is file:
  Verify file exists and has .adoc extension
  scope = "single"

If target is directory:
  Verify directory exists
  scope = "batch"

If target not found:
  Error: "Target not found: {target}"
```

### Step 3: Load Documentation Skill

```
Skill: pm-documents:ref-documentation
```

### Step 4: Execute Action

**For action = sync:**
```
Execute workflow: sync-with-code
Parameters:
  target: {target}
  code_path: src/ (or auto-detect)

Reports:
- Code changes without documentation
- Documentation for removed code
- Outdated documentation sections
```

**For action = cleanup:**
```
Execute workflow: cleanup-stale
Parameters:
  target: {target}

Reports:
- Duplicate content across files
- Orphaned documentation
- Stale content with TODOs

Prompts user before any removal.
```

**For action = update:**
```
Execute workflow: refresh-metadata
Parameters:
  target: {target}

Actions:
- Fix broken cross-references
- Update header metadata
- Ensure consistent formatting
```

### Step 5: Generate Report

**For sync:**
```
═══════════════════════════════════════════════
Documentation Sync Report
═══════════════════════════════════════════════

Target: {target}
Code analyzed: {file_count} files

Drift Detected:
X {count} items need attention

Details:
- {description of each drift item}

Recommendations:
1. {action to take}
```

**For cleanup:**
```
═══════════════════════════════════════════════
Documentation Cleanup Report
═══════════════════════════════════════════════

Target: {target}
Files analyzed: {count}

Candidates:
- Duplicates: {count}
- Orphaned: {count}
- Stale: {count}

{Detailed list of candidates}

Actions Taken:
- {list of cleanup actions performed}
```

**For update:**
```
═══════════════════════════════════════════════
Documentation Update Report
═══════════════════════════════════════════════

Target: {target}
Files processed: {count}

Updates Applied:
Y Metadata fixed: {count}
Y Cross-references fixed: {count}
Y Headers updated: {count}

Manual Review Needed:
- {file}: {reason}
```

## Architecture

**Pattern**: Thin Orchestrator (~110 lines)
- Parses action and target
- Routes to appropriate skill workflow
- No business logic in skill

**Skill Dependency**: pm-documents:ref-documentation
- Provides: sync-with-code, cleanup-stale, refresh-metadata workflows

## Related

- `/doc-doctor` - Diagnose documentation issues
- `/doc-create` - Create new documentation
- `ref-documentation` skill - Provides maintenance workflows

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…

Newsletter

Get the weekly list of safe new skills, and the ones we pulled.