Skip to content

magnificentlycursed/skills

Repository files navigation

Skills

A collection of Claude Code skills (slash commands) for software development workflows.

Installation

Copy the skill files you want into your project's .claude/commands/ directory:

cp .claude/commands/tech-write.md  /path/to/your-project/.claude/commands/
cp .claude/commands/doc-review.md  /path/to/your-project/.claude/commands/

Create the directory if it doesn't exist:

mkdir -p /path/to/your-project/.claude/commands

The skills are available immediately in any Claude Code session opened in that project — no restart required.

Skills

/tech-write — Technical Writer

Generates project documentation into docs/ by exploring the codebase, explaining files and modules, and highlighting non-obvious code.

Usage:

/tech-write                        # document the entire project
/tech-write src/auth/              # document a directory
/tech-write src/auth/session.rs    # document a single file

What it produces:

  • docs/README.md — project overview, directory layout, key entry points (full project only)
  • docs/<dir>/README.md — per-directory index with file descriptions and conventions
  • docs/<file>.md — per-file detail with purpose, key exports, notable complexity, and dependencies

The docs/ directory is created automatically if absent. The doc tree mirrors the source tree: src/auth/session.rsdocs/src/auth/session.rs.md.

Notable complexity sections are included only when genuine complexity signals are detected (nesting depth ≥ 3, closure chains, unsafe patterns, non-obvious side effects) — never fabricated for simple code.


/doc-review — Document Reviewer

Audits existing documentation in docs/ for correctness, coverage gaps, and staleness. Reports findings and optionally fixes them by invoking /tech-write.

Usage:

/doc-review                        # audit all docs
/doc-review src/auth/              # audit docs for a specific source path
/doc-review --fix                  # audit and automatically re-generate stale/broken docs

What it checks:

Check Method Finding tag
Broken references Backtick identifiers and file paths in docs verified against source tree [BROKEN REF]
Staleness Git commit timestamps compared: source newer than doc [STALE]
Coverage Source files with no corresponding doc file [UNDOCUMENTED]

Example output:

Doc Review Report
=================

Correctness:   1 broken ref
Staleness:     1 stale doc
Coverage:      1 undocumented file

Findings:
  [BROKEN REF]    docs/src/auth.md → function `validate_token` not found in source
  [STALE]         docs/src/session.md — source changed 2026-03-28, doc last updated 2026-01-15
  [UNDOCUMENTED]  src/cache/lru.rs

Next steps:
  /tech-write src/auth/
  /tech-write src/cache/lru.rs
  (or re-run with --fix to apply automatically)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors