做什么
创建全面的开发者登入文档,包括设置指南、 README 文件、 贡献指南以及开始的教程
技能库 智客分类:文档办公 developer-onboarding
创建全面的开发者登入文档,包括设置指南,README文件,贡献指南,以及开始的教程. 启用新开发者或创建设置文档时使用 .
官方网址:skills.sh
先看中文介绍;官方 description 原文单独保留,不改写 SKILL.md。
创建全面的开发者登入文档,包括设置指南、 README 文件、 贡献指南以及开始的教程
[#当-用时]
按 Agent Skills 渐进披露:启动时只加载 name 与 description(约 100 token);任务匹配后才读入整份 SKILL.md 正文;scripts/、references/、assets/ 仅在需要时再读。 本文件正文结构:Developer Onboarding、Table of Contents、Overview、When to Use、Quick Start、Project Name。
文件分析:除 SKILL.md 外,正文引用了 references/clone-the-repository.md、references/set-up-environment-variables.md、references/database-setup.md、references/project-structure.md、references/available-scripts.md、references/code-style.md,属于带资源的技能包,这些文件按需再读。
Create comprehensive developer onboarding documentation including setup guides, README files, contributing guidelines, and getting started tutorials. Use when onboarding new developers or creating setup documentation.
Developer OnboardingTable of ContentsOverviewWhen to UseQuick StartProject NameTable of ContentsFeaturesReference GuidesBest Practices✅ DO❌ DON'T
来源分类:skills.sh agent-skill
namedeveloper-onboardingdescriptionreferences/clone-the-repository.mdreferences/set-up-environment-variables.mdreferences/database-setup.mdreferences/project-structure.mdreferences/available-scripts.mdreferences/code-style.mdreferences/git-workflow.mdreferences/running-tests.mdreferences/writing-tests.md以下路径提取自原文;文件是否齐全请以来源仓库中的完整目录为准。
具体调用语法与可用工具以目标 Agent 客户端为准。 查看调用机制说明 ↗
先选择目标 Agent 和安装范围,保留技能包的附属文件,安装后检查客户端能否发现该技能。
该技能引用了附属文件,请从来源获取完整目录;仅复制 SKILL.md 可能缺少依赖。
复制安装指令给支持 Agent Skills 的代理,确认其中的目标目录与客户端匹配。
把 Agent Skill「developer-onboarding」安装到我的项目:SKILL.md 原文与官方 description 见 https://zicq.com/zh/skills/skl-67392d9a722053ac-%E5%BC%80%E5%8F%91%E8%80%85%E7%99%BB%E5%85%A5.html 请存为 .cursor/skills/developer-onboarding/SKILL.md 或 .claude/skills/developer-onboarding/SKILL.md,frontmatter 的 name 与 description 保持原样,不要改写。 该技能还带 scripts/、references/、assets/ 等文件,请从 https://github.com/aj-geddes/useful-ai-prompts 取完整目录,不要只建一个 SKILL.md。
需要 Node.js 与 npx。先查看仓库技能列表,确认实际名称。
npx skills add 'https://github.com/aj-geddes/useful-ai-prompts' --list
npx skills add 'https://github.com/aj-geddes/useful-ai-prompts' --skill 'developer-onboarding'
CLI 会交互选择目标 Agent,默认安装到项目;用户级安装使用 -g。先通过查看命令核对仓库内容,再用 npx skills list 检查已安装技能。
Create comprehensive onboarding documentation that helps new developers quickly set up their development environment, understand the codebase, and start contributing effectively.
Minimal working example:
# Project Name
Brief project description (1-2 sentences explaining what this project does).
[](https://github.com/username/repo/actions)
[](https://codecov.io/gh/username/repo)
[](LICENSE)
[](https://www.npmjs.com/package/package-name)
## Table of Contents
- [Features](#features)
- [Quick Start](#quick-start)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Configuration](#configuration)
- [Development](#development)
- [Testing](#testing)
- [Deployment](#deployment)
- [Architecture](#architecture)
- [Contributing](#contributing)
- [License](#license)
## Features
// ... (see reference guides for full implementation)
```
## Reference Guides
Detailed implementations in the `references/` directory:
| Guide | Contents |
|---|---|
| [Clone the Repository](references/clone-the-repository.md) | Clone the Repository, Install Dependencies |
| [Set Up Environment Variables](references/set-up-environment-variables.md) | Set Up Environment Variables |
| [Database Setup](references/database-setup.md) | Database Setup, Verify Installation |
| [Project Structure](references/project-structure.md) | Project Structure |
| [Available Scripts](references/available-scripts.md) | Available Scripts |
| [Code Style](references/code-style.md) | Code Style |
| [Git Workflow](references/git-workflow.md) | Git Workflow |
| [Running Tests](references/running-tests.md) | Running Tests |
| [Writing Tests](references/writing-tests.md) | Writing Tests |
## Best Practices
### ✅ DO
- Start with a clear, concise project description
- Include badges for build status, coverage, etc.
- Provide a quick start section
- Document all prerequisites clearly
- Include troubleshooting section
- Keep README up-to-date
- Use code examples liberally
- Add architecture diagrams
- Document environment variables
- Include contribution guidelines
- Specify code style requirements
- Document testing procedures
### ❌ DON'T
- Assume prior knowledge
- Skip prerequisite documentation
- Forget to update after major changes
- Use overly technical jargon
- Skip example code
- Ignore Windows/Mac/Linux differences
- Forget to document scripts
文档办公
为结构化的代理内存和可堆肥技能所打入的知识图. 在创建/征服实体(Person, project, Task, Evention, Document)时使用,链接相关对象,强制约束,规划多步动作作为图变,或技能需要共享状态时使用. 触发到"记住","我知道什么","链接X到Y",…
文档办公
使用纳米-pdf CLI编辑带有自然语言指令的PDF.
文档办公
创建,检查,并编辑有可靠样式的Microsoft Word文档和DOCX文件,编号,跟踪更改,表格,章节,并进行相容性检查. 当 (1) 任务涉及 Word 或 ".docx " 时使用; (2) 文件包括跟踪的更改,评论,字段,表格,模板,或页面布局限制; (3) 文档必须在不…
文档办公
通过 Maton 网关调用第三方 API, 它为用户已经连接的应用程序注入证书 。 当用户命名一个连接的应用程序和其中的具体行动时使用此技能——读取一个邮箱,查询一个CMM,归档一个问题,更新一个电子表格,通过一个连接的搜索或刮取提供者运行一个查询. 每一次通话都到用户连接的应用…