DocumentationPROPRO REQUIREDFC-DOC-006
SDK Doc Claw
sdk-doc-claw
v0.2.0May 22, 2026SDK documentation with code examples, type definitions, and quick-start guides that match the actual API
SDK documentation that starts with the class hierarchy instead of the developer's goal is documentation written for the author, not the user. I build SDK docs that lead with use cases, show idiomatic code in the target language, and include error-handling patterns because nobody's first API call succeeds.
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
- All public methods documented
- Functional examples provided
- Error handling documented
- Version compatibility noted
- Complete and structured response
3 GATES DEFINED
Expected Outputs
SDK Reference with Idiomatic Code Examples per LanguageQuickstart Guide with Five-Minute Integration PathType Definition/Interface Exhaustiveness Report
Native exports per tool
OpenClaw10 files
openclaw/AGENTS.mdopenclaw/SOUL.mdopenclaw/TOOLS.md+7 moreHermes5 files
hermes/skills/flickclaw/sdk-doc-claw/SKILL.mdhermes/skills/flickclaw/sdk-doc-claw/references/workflow.mdhermes/skills/flickclaw/sdk-doc-claw/references/quality-gates.md+2 moreClaude Code6 files
claude-code/CLAUDE.mdclaude-code/.claude/skills/sdk-doc-claw/SKILL.mdclaude-code/.claude/skills/sdk-doc-claw/references/workflow.md+3 moreCodex5 files
codex/AGENTS.mdcodex/.flickclaw/agents/sdk-doc-claw/codex.mdcodex/.flickclaw/agents/sdk-doc-claw/workflow.md+2 moreCursor3 files
cursor/.cursor/rules/flickclaw-sdk-doc-claw.mdccursor/.cursor/rules/flickclaw-sdk-doc-claw-workflow.mdccursor/.cursor/rules/flickclaw-sdk-doc-claw-quality-gates.mdcWindsurf3 files
windsurf/.windsurf/rules/flickclaw-sdk-doc-claw.mdwindsurf/.windsurf/rules/flickclaw-sdk-doc-claw-workflow.mdwindsurf/.windsurf/rules/flickclaw-sdk-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 sdk-doc-claw --target openclawDownload as ZIP
Example Prompt
Try this prompt with SDK Doc Claw to see what it can do:
Review the documentation and identify gaps. Generate SDK Reference with Idiomatic Code Examples per Language, Quickstart Guide with Five-Minute Integration Path, Type Definition/Interface Exhaustiveness Report covering setup, API reference, and troubleshooting.Example Output
IllustrativeWhat a typical SDK Doc Claw report looks like:
# SDK 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 SDK 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 - [✓] every_public_method_has_a_code_example_in_the_target_language - [✓] error_handling_and_retry_patterns_documented_per_client - [✓] type_definitions_or_interface_signatures_are_exhaustive ## Outputs Generated - **SDK Reference with Idiomatic Code Examples per Language**: Included in the report above. - **Quickstart Guide with Five-Minute Integration Path**: Included in the report above. - **Type Definition/Interface Exhaustiveness Report**: 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