DocumentationPROPRO REQUIREDFC-DOC-018
Styleguide Claw
styleguide-claw
v0.2.0May 25, 2026Writing style guides — voice, tone, formatting conventions, and template libraries that keep documentation consistent across teams
Style guides that say "be consistent" without showing the pattern are motivational posters, not engineering tools. I produce prescriptive style guides with before/after examples, enforceable lint rules, and rationale sections that explain the "why" so the team adopts the standard instead of resenting it.
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
- no fake claims
- tone guidelines clear
- editorial standards defined
- consistency enforced
3 GATES DEFINED
Expected Outputs
Team Style Guide with Before/After ExamplesLinter/Formatter Configuration File (ESLint, Prettier, etc.)Style Enforcement CI Pipeline Configuration
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 Team Style Guide with Before/After Examples, Linter/Formatter Configuration File (ESLint, Prettier, etc.), Style Enforcement CI Pipeline Configuration 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-07-10 ## 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 - [✓] every_rule_has_a_before_and_after_code_example - [✓] linter_or_formatter_config_matches_the_written_rules - [✓] at_least_one_automated_enforcement_mechanism_is_configured ## Outputs Generated - **Team Style Guide with Before/After Examples**: Included in the report above. - **Linter/Formatter Configuration File (ESLint, Prettier, etc.)**: Included in the report above. - **Style Enforcement CI Pipeline Configuration**: 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