DocumentationPROPRO REQUIREDFC-DOC-018
Styleguide Claw
styleguide-claw
Style guide creation: writing standards, tone guides, and documentation conventions.
Styleguide Claw creates writing style guides with tone guidelines, documentation conventions, and editorial standards for consistent team output.
OpenClaw
Hermes
Claude Code
Codex
Cursor
Windsurf
Aider
OllamaPRIMARY ACTION
Unlock with ProCOMPATIBLE WITH
OpenClawHermesClaude CodeCodex+4
OpenClaw is the default target. Cursor example below.
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
No explicit gate list for this agent in the current dataset.
4 GATES DEFINED
Expected Outputs
Native exports per tool
OpenClaw10 files
openclaw/AGENTS.mdopenclaw/SOUL.mdopenclaw/TOOLS.md+7 moreHermes5 files
hermes/skills/flickclaw/styleguide-claw/SKILL.mdhermes/skills/flickclaw/styleguide-claw/references/workflow.mdhermes/skills/flickclaw/styleguide-claw/references/quality-gates.md+2 moreClaude Code6 files
claude-code/CLAUDE.mdclaude-code/.claude/skills/styleguide-claw/SKILL.mdclaude-code/.claude/skills/styleguide-claw/references/workflow.md+3 moreCodex5 files
codex/AGENTS.mdcodex/.flickclaw/agents/styleguide-claw/codex.mdcodex/.flickclaw/agents/styleguide-claw/workflow.md+2 moreCursor3 files
cursor/.cursor/rules/flickclaw-styleguide-claw.mdccursor/.cursor/rules/flickclaw-styleguide-claw-workflow.mdccursor/.cursor/rules/flickclaw-styleguide-claw-quality-gates.mdcWindsurf3 files
windsurf/.windsurf/rules/flickclaw-styleguide-claw.mdwindsurf/.windsurf/rules/flickclaw-styleguide-claw-workflow.mdwindsurf/.windsurf/rules/flickclaw-styleguide-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 styleguide-claw --target openclawDownload as ZIP
Example Prompt
Try this prompt with Styleguide Claw to see what it can do:
Review the documentation and identify gaps. Generate covering setup, API reference, and troubleshooting.Example Output
IllustrativeWhat a typical Styleguide Claw report looks like:
# Styleguide Claw — Assessment Report **Project**: api-docs-site **Context**: a developer documentation site with OpenAPI specs and tutorials **Generated**: 2026-05-26 ## Executive Summary The Styleguide 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 - [✓] no_fake_claims - [✓] tone_guidelines_clear - [✓] editorial_standards_defined ## Outputs Generated ## Validation - [x] All quality gates passed (3/3) - [x] 3 findings documented with severity and remediation - [x] 0 output sections generated - [x] Evidence collected and referenced --- *This is an illustrative example output from FlickClaw. Results vary based on project context.*