Loading...
Loading...
Scaffold and audit OSS documentation for open source projects. Use for "add OSS docs", "create README", "setup contributing", "add changelog", "prepare for open source", or "add AGENTS.md".
npx skill4agent add boshu2/agentops oss-docs| Command | Action |
|---|---|
| Check which OSS docs exist/missing |
| Create all missing standard files |
| Create specific file |
| Refresh existing docs with latest patterns |
| Check docs follow best practices |
# 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| File | Purpose |
|---|---|
| Legal terms |
| Project overview |
| How to contribute |
| Community standards |
| File | Purpose |
|---|---|
| Vulnerability reporting |
| Version history |
| AI assistant context |
| Issue templates |
| PR template |
| File | When Needed |
|---|---|
| Complex setup |
| Non-trivial codebase |
| CLI tools |
| Configurable software |
| Complex workflows |
| Project Type | Focus |
|---|---|
| Installation, commands, examples |
| K8s CRDs, RBAC, deployment |
| API, configuration, deployment |
| API reference, examples |
| Values, dependencies, upgrading |
project/
├── README.md # Overview + quick start
├── AGENTS.md # AI assistant context
├── CONTRIBUTING.md # Contributor guide
├── CHANGELOG.md # Keep a Changelog format
├── docs/
│ ├── QUICKSTART.md # Detailed getting started
│ ├── CLI_REFERENCE.md # Complete command reference
│ ├── ARCHITECTURE.md # System design
│ └── CONFIG.md # Configuration options
└── examples/
└── README.md # Examples index# Agent Instructions
This project uses **<tool>** for <purpose>. Run `<onboard-cmd>` to get started.
## Quick Reference
```bash
<cmd1> # Do thing 1
<cmd2> # Do thing 2
---
## Style Guidelines
1. **Be direct** - Get to the point quickly
2. **Be friendly** - Welcome contributions
3. **Be concise** - Avoid boilerplate
4. **Use tables** - For commands, options, features
5. **Show examples** - Code blocks over prose
6. **Link liberally** - Cross-reference related docs
---
## Skill Boundaries
**DO:**
- Audit existing documentation
- Generate standard OSS files
- Validate documentation quality
**DON'T:**
- Overwrite existing content without confirmation
- Generate code documentation (use `$doc`)
- Create CI/CD files (use `$golden-init`)
## Examples
### OSS Readiness Audit
**User says:** "Audit this repo for open-source documentation readiness."
**What happens:**
1. Evaluate presence/quality of core OSS docs.
2. Identify missing or weak sections.
3. Output prioritized documentation actions.
### Scaffold Missing Docs
**User says:** "Generate missing OSS docs for this project."
**What happens:**
1. Detect project type and documentation gaps.
2. Scaffold standard files with project-aware content.
3. Produce a checklist for final review and landing.
## Troubleshooting
| Problem | Cause | Solution |
|---------|-------|----------|
| Generated docs feel generic | Project signals too sparse | Add concrete repo context (commands, architecture, workflows) |
| Existing docs conflict | Legacy text diverges from current behavior | Reconcile with current code/process and mark obsolete sections |
| Contributor path unclear | Missing setup/testing guidance | Add explicit quickstart and validation commands |
| Open-source handoff incomplete | Session-end workflow not reflected | Add landing-the-plane and release hygiene steps |