Specification
- Skill ID
- aj-geddes/useful-ai-prompts/developer-onboarding
- Publisher
- aj-geddes
- Repository
- useful-ai-prompts
- Installs
- 0
- Files
- 11
- Synced
- Sep 23, 2026
How to use it
Open any RiverX project, open the Skills panel in the chat, and search for this identifier. The files are fetched from the source repository at install time.
aj-geddes/useful-ai-prompts/developer-onboardingInstalls these files- SKILL.md
- references/available-scripts.md
- references/clone-the-repository.md
- references/code-style.md
- references/database-setup.md
- references/git-workflow.md
- references/project-structure.md
- references/running-tests.md
- references/set-up-environment-variables.md
- references/writing-tests.md
- templates/doc-template.md
What this skill tells the agent
Developer Onboarding
Table of Contents
- Overview
- When to Use
- Quick Start
- Reference Guides
- Best Practices
Overview
Create comprehensive onboarding documentation that helps new developers quickly set up their development environment, understand the codebase, and start contributing effectively.
When to Use
- New developer onboarding
- README file creation
- Contributing guidelines
- Development environment setup
- Architecture overview docs
- Code style guides
- Git workflow documentation
- Testing guidelines
- Deployment procedures
Quick Start
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 | Clone the Repository, Install Dependencies |
| Set Up Environment Variables | Set Up Environment Variables |
| Database Setup | Database Setup, Verify Installation |
| Project Structure | Project Structure |
| Available Scripts | Available Scripts |
| Code Style | Code Style |
| Git Workflow | Git Workflow |
| Running Tests | Running Tests |
| Writing Tests | 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
More from aj-geddes
Use this skill in a project
Open any RiverX project, search the Skills panel for aj-geddes/useful-ai-prompts/developer-onboarding, and install it in one click.