npx skills add https://github.com/boshu2/agentops --skill oss-docs为开源项目搭建文档框架并进行审计。
此技能通过以下方式帮助仓库准备开源发布:
| 命令 | 操作 |
|---|---|
audit | 检查哪些 OSS 文档存在/缺失 |
scaffold | 创建所有缺失的标准文件 |
scaffold [file] | 创建特定文件 |
update | 使用最新模式刷新现有文档 |
validate |
广告位招租
在这里展示您的产品或服务
触达数万 AI 开发者,精准高效
| 检查文档是否遵循最佳实践 |
# 确定项目类型和语言
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")
# 检测项目类别
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
| 文件 | 用途 |
|---|---|
LICENSE | 法律条款 |
README.md | 项目概述 |
CONTRIBUTING.md | 如何贡献 |
CODE_OF_CONDUCT.md | 社区标准 |
| 文件 | 用途 |
|---|---|
SECURITY.md | 漏洞报告 |
CHANGELOG.md | 版本历史 |
AGENTS.md | AI 助手上下文 |
.github/ISSUE_TEMPLATE/ | 议题模板 |
.github/PULL_REQUEST_TEMPLATE.md | PR 模板 |
| 文件 | 何时需要 |
|---|---|
docs/QUICKSTART.md | 复杂设置 |
docs/ARCHITECTURE.md | 非简单代码库 |
docs/CLI_REFERENCE.md | CLI 工具 |
docs/CONFIG.md | 可配置软件 |
examples/ | 复杂工作流 |
| 项目类型 | 侧重点 |
|---|---|
cli | 安装、命令、示例 |
operator | K8s CRDs、RBAC、部署 |
service | API、配置、部署 |
library | API 参考、示例 |
helm | 值、依赖项、升级 |
project/
├── README.md # 概述 + 快速开始
├── AGENTS.md # AI 助手上下文
├── CONTRIBUTING.md # 贡献者指南
├── CHANGELOG.md # Keep a Changelog 格式
├── docs/
│ ├── QUICKSTART.md # 详细入门指南
│ ├── CLI_REFERENCE.md # 完整命令参考
│ ├── ARCHITECTURE.md # 系统设计
│ └── CONFIG.md # 配置选项
└── examples/
└── README.md # 示例索引
# 助手指令
此项目使用 **<tool>** 用于 <purpose>。运行 `<onboard-cmd>` 以开始。
## 快速参考
```bash
<cmd1> # 做事情 1
<cmd2> # 做事情 2
强制工作流程:
执行:
不执行:
$doc)用户说: "审计此仓库的开源文档就绪情况。"
发生的情况:
用户说: "为此项目生成缺失的 OSS 文档。"
发生的情况:
| 问题 | 原因 | 解决方案 |
|---|---|---|
| 生成的文档感觉泛泛 | 项目信号过于稀疏 | 添加具体的仓库上下文(命令、架构、工作流) |
| 现有文档冲突 | 遗留文本与当前行为不符 | 与当前代码/流程协调并标记过时部分 |
| 贡献者路径不清晰 | 缺少设置/测试指南 | 添加明确的快速入门和验证命令 |
| 开源交接不完整 | 会话结束工作流程未体现 | 添加完成会话和发布卫生步骤 |
每周安装数
128
仓库
GitHub 星标数
197
首次出现
2026年2月18日
安全审计
安装于
opencode128
gemini-cli125
github-copilot125
codex125
kimi-cli125
amp125
Scaffold and audit documentation for open source projects.
This skill helps prepare repositories for open source release by:
| 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 |
# 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 |
|---|---|
LICENSE | Legal terms |
README.md | Project overview |
CONTRIBUTING.md | How to contribute |
CODE_OF_CONDUCT.md | Community standards |
| File | Purpose |
|---|---|
SECURITY.md | Vulnerability reporting |
CHANGELOG.md | Version history |
AGENTS.md | AI assistant context |
.github/ISSUE_TEMPLATE/ | Issue templates |
.github/PULL_REQUEST_TEMPLATE.md | PR template |
| File | When Needed |
|---|---|
docs/QUICKSTART.md | Complex setup |
docs/ARCHITECTURE.md | Non-trivial codebase |
docs/CLI_REFERENCE.md | CLI tools |
docs/CONFIG.md | Configurable software |
examples/ | Complex workflows |
| Project Type | Focus |
|---|---|
cli | Installation, commands, examples |
operator | K8s CRDs, RBAC, deployment |
service | API, configuration, deployment |
library | API reference, examples |
helm | 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
MANDATORY WORKFLOW:
---
## 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 (out of scope — configure CI/CD separately)
## 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 |
## Reference Documents
- [references/beads-patterns.md](references/beads-patterns.md)
- [references/documentation-tiers.md](references/documentation-tiers.md)
- [references/project-types.md](references/project-types.md)
Weekly Installs
128
Repository
GitHub Stars
197
First Seen
Feb 18, 2026
Security Audits
Gen Agent Trust HubPassSocketFailSnykPass
Installed on
opencode128
gemini-cli125
github-copilot125
codex125
kimi-cli125
amp125
Skills CLI 使用指南:AI Agent 技能包管理器安装与管理教程
33,600 周安装
PowerShell 7 专家指南:跨平台自动化、并行处理与REST API集成
167 周安装
用户画像创建指南:AI辅助工具与Python代码示例,提升产品设计与营销效果
167 周安装
GitHub PR自动生成工具 - 智能拉取请求摘要生成器,提升开发团队协作效率
167 周安装
SwiftUI设计原则:间距、排版与原生组件使用指南,打造专业iOS应用
167 周安装
agent-eval:编程智能体评估工具,自动化测试比较AI代码助手性能
167 周安装
Encore.ts 声明式基础设施:PostgreSQL、Redis、Pub/Sub、定时任务、对象存储
167 周安装