developer-onboarding by aj-geddes/useful-ai-prompts
npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill developer-onboarding创建全面的入职文档,帮助新开发者快速搭建开发环境、理解代码库并开始高效贡献。
最小工作示例:
# 项目名称
项目简要描述(用 1-2 句话解释该项目的作用)。
[](https://github.com/username/repo/actions)
[](https://codecov.io/gh/username/repo)
[](LICENSE)
[](https://www.npmjs.com/package/package-name)
## 目录
- [功能特性](#功能特性)
- [快速开始](#快速开始)
- [先决条件](#先决条件)
- [安装](#安装)
- [配置](#配置)
- [开发](#开发)
- [测试](#测试)
- [部署](#部署)
- [架构](#架构)
- [贡献](#贡献)
- [许可证](#许可证)
## 功能特性
// ... (完整实现请参阅参考指南)
广告位招租
在这里展示您的产品或服务
触达数万 AI 开发者,精准高效
references/ 目录下的详细实现:
每周安装量
131
仓库
GitHub 星标数
126
首次出现
2026年1月21日
安全审计
安装于
opencode114
gemini-cli106
codex104
claude-code101
cursor100
github-copilot92
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
Weekly Installs
131
Repository
GitHub Stars
126
First Seen
Jan 21, 2026
Security Audits
Gen Agent Trust HubPassSocketPassSnykPass
Installed on
opencode114
gemini-cli106
codex104
claude-code101
cursor100
github-copilot92
React 组合模式指南:Vercel 组件架构最佳实践,提升代码可维护性
113,700 周安装
Go测试最佳实践指南:编写清晰可维护的Go测试代码规范
359 周安装
项目代码质量工具自动配置协调器 - 支持TypeScript、.NET、Python
150 周安装
Sentry Skills技能创建工具 - 兼容skill-creator,使用skill-writer标准工作流
366 周安装
TypeScript高级类型完全指南:泛型、条件类型、映射类型、实用工具类型详解
361 周安装
Django性能审查指南:识别N+1查询、缺失索引等关键性能问题
369 周安装
Typst 排版系统教程:比 LaTeX 更简单、编译更快的现代化文档排版工具
365 周安装