oss-docslisted
Install: claude install-skill boshu2/agentops
# OSS Documentation Skill
Scaffold and audit documentation for open source projects.
## Overview
This skill helps prepare repositories for open source release by:
1. Auditing existing documentation completeness
2. Scaffolding missing standard files
3. Generating content tailored to project type
## Commands
| Command | Action |
|---------|--------|
| `audit` | Check which OSS docs exist/missing |
| `scaffold` | Create all missing standard files |
| `scaffold [file]` | Create specific file |
| `update` | Refresh existing docs with latest patterns |
| `validate` | Check docs follow best practices |
---
## Phase 0: Project Detection
```bash
# Determine project type and language
PROJECT_NAME=$(basename $(pwd))
LANGUAGES=()
[[ -f go.mod ]] && LANGUAGES+=("go")
[[ -f pyproject.toml ]] || [[ -f setup.py ]] && LANGUAGES+=("python")
[[ -f package.json ]] && LANGUAGES+=("javascript")
[[ -f Cargo.toml ]] && LANGUAGES+=("rust")
# Detect project category
if [[ -f Dockerfile ]] && [[ -d cmd ]]; then
PROJECT_TYPE="cli"
elif [[ -d config/crd ]]; then
PROJECT_TYPE="operator"
elif [[ -f Chart.yaml ]]; then
PROJECT_TYPE="helm"
else
PROJECT_TYPE="library"
fi
```
---
## Subcommand: audit
### Required Files (Tier 1 - Core)
| File | Purpose |
|------|---------|
| `LICENSE` | Legal terms |
| `README.md` | Project overview |
| `CONTRIBUTING.md` | How to contribute |
| `CODE_OF_CONDUCT.md` | Community standards |
### Recommended Files (Tier 2 - Standard)
| File | Purpose