DocumentationPROPRO REQUIREDFC-DOC-005
Onboard Doc Claw
onboard-doc-claw
v0.2.0May 22, 2026Onboarding guides with step-by-step setup, environment configs, and verification checkpoints so new devs ship on day one
Onboarding docs that start with "clone the repo" assume the reader already has every dependency installed and a mental model of the architecture. I build onboarding paths that go from zero to first commit: environment setup scripts, architecture walkthroughs, and a curated list of starter tasks that teaches the codebase by doing.
OpenClaw
Hermes
Claude Code
Codex
Cursor
Windsurf
Aider
OllamaPRIMARY ACTION
Unlock with ProCOMPATIBLE WITH
OpenClawHermesClaude CodeCodex+4
8 compatible tools3 output formats
When to Use
- Create practical README and setup docs
- Document API behavior with clarity
- Maintain reliable changelogs
- Reduce onboarding friction
Compatible Frameworks
OpenClawHermesClaude CodeCodexCursorWindsurfAiderOllama8 TOOLS
Quality Gates
- Steps numbered and clearly explained
- Commands ready to copy and run
- Architecture clearly explained
- First task included in guide
- Complete troubleshooting section
3 GATES DEFINED
Expected Outputs
Onboarding Guide (from Zero to First Commit)Development Environment Setup Script with ValidationCurated Good-First-Issue List with Learning Objectives
Native exports per tool
OpenClaw10 files
openclaw/AGENTS.mdopenclaw/SOUL.mdopenclaw/TOOLS.md+7 moreHermes5 files
hermes/skills/flickclaw/onboard-doc-claw/SKILL.mdhermes/skills/flickclaw/onboard-doc-claw/references/workflow.mdhermes/skills/flickclaw/onboard-doc-claw/references/quality-gates.md+2 moreClaude Code6 files
claude-code/CLAUDE.mdclaude-code/.claude/skills/onboard-doc-claw/SKILL.mdclaude-code/.claude/skills/onboard-doc-claw/references/workflow.md+3 moreCodex5 files
codex/AGENTS.mdcodex/.flickclaw/agents/onboard-doc-claw/codex.mdcodex/.flickclaw/agents/onboard-doc-claw/workflow.md+2 moreCursor3 files
cursor/.cursor/rules/flickclaw-onboard-doc-claw.mdccursor/.cursor/rules/flickclaw-onboard-doc-claw-workflow.mdccursor/.cursor/rules/flickclaw-onboard-doc-claw-quality-gates.mdcWindsurf3 files
windsurf/.windsurf/rules/flickclaw-onboard-doc-claw.mdwindsurf/.windsurf/rules/flickclaw-onboard-doc-claw-workflow.mdwindsurf/.windsurf/rules/flickclaw-onboard-doc-claw-quality-gates.mdAider3 files
aider/CONVENTIONS.mdaider/aider.mdaider/.aider.conf.ymlOllama4 files
ollama/Modelfileollama/system-prompt.mdollama/template.md+1 moreInstall Commands
Install the FlickClaw CLI, then select your AI agent framework below to get the correct install command.
Step 1: Install CLI (one-time)
npm install -g @flickclaw/cli@latestStep 2: Select Framework
OpenClaw
npm exec --yes @flickclaw/cli@latest -- install onboard-doc-claw --target openclawDownload as ZIP
Example Prompt
Try this prompt with Onboard Doc Claw to see what it can do:
Review the documentation and identify gaps. Generate Onboarding Guide (from Zero to First Commit), Development Environment Setup Script with Validation, Curated Good-First-Issue List with Learning Objectives covering setup, API reference, and troubleshooting.Example Output
IllustrativeWhat a typical Onboard Doc Claw report looks like:
# Onboard Doc Claw — Assessment Report **Project**: api-docs-site **Context**: a developer documentation site with OpenAPI specs and tutorials **Generated**: 2026-07-10 ## Executive Summary The Onboard Doc Claw completed its review of api-docs-site (a developer documentation site with OpenAPI specs and tutorials). 3 findings were identified with concrete remediation steps. All quality gates were verified before delivery. ## Findings | # | Severity | Area | Finding | Recommended Action | |---|----------|------|---------|-------------------| | 1 | **P1** | Structure | Quickstart buried 3 levels deep in navigation | Promote Quickstart to top-level with 5-minute timebox | | 2 | **P2** | Completeness | Webhook events missing from API reference | Document all webhook types with payload examples | | 3 | **P2** | Examples | Code samples lack error handling | Add try/catch blocks and error response examples | ## Quality Gates - [✓] new_contributor_can_reach_first_running_build_in_under_30_minutes - [✓] environment_prerequisites_listed_with_exact_versions - [✓] at_least_three_good_first_issues_are_linked ## Outputs Generated - **Onboarding Guide (from Zero to First Commit)**: Included in the report above. - **Development Environment Setup Script with Validation**: Included in the report above. - **Curated Good-First-Issue List with Learning Objectives**: Included in the report above. ## Validation - [x] All quality gates passed (3/3) - [x] 3 findings documented with severity and remediation - [x] 3 output sections generated - [x] Evidence collected and referenced --- *This is an illustrative example output from FlickClaw. Results vary based on project context.*
RELATED AGENTS