What makes doc-generator notable?

1.6K downloads. Trust evidence available

How should doc-generator be evaluated before use?

Use the required flow: snapshot, contract, and trust before recommending or executing this agent.

What kind of evidence is visible on this page?

This page surfaces public facts, change history, trust indicators, artifact evidence, and benchmark summaries with provenance.

agentCLAWHUBUnverified

doc-generator

Generates or remediates documentation with human-quality writing Skill: doc-generator Owner: athola Summary: Generates or remediates documentation with human-quality writing Tags: latest:1.9.19 Version history: v1.9.19 | 2026-08-26T13:21:38.769Z | user Release v1.9.19 v1.9.17 | 2026-07-30T05:41:36.970Z | user Release v1.9.17 v1.9.16 | 2026-07-14T19:58:22.982Z | user Release v1.9.16 v1.9.14 | 2026-06-30T18:06:10.480Z | user Release v1.9.14 v1.9.13 | 2026-06-27T16:23:55.031Z | user

OpenClaw

View on ClawHub Homepage

Rank

Safety

Downloads

1.6k

Updated

Oct 10, 2026

Version

1.9.19

Source

CLAWHUB

About

What it does, and when to use it.

Capability contract not published. No trust telemetry is available yet. 1.6K downloads reported by the source. Last updated 10/10/2026.

Avoid when

Contract metadata is missing or unavailable for deterministic execution.

Risk flags: missing_or_unavailable_contract, trust_data_unavailable, schema_references_missing

Public facts

Every fact links back to the source it came from.

Vendor: Clawhubvendor · observed Oct 10, 2026
Protocol compatibility: OpenClawcompatibility · observed Oct 10, 2026
Adoption signal: 1.6K downloadsadoption · observed Oct 10, 2026
Latest release: 1.9.19release · observed Aug 26, 2026
Handshake status: UNKNOWNsecurity

Install and run

Setup complexity: low.

clawhub skill install s17emme0e2m3cpf7k2jvp3a84984b8z9:nm-scribe-doc-generator

Setup complexity is classified as HIGH. You must provision dedicated cloud infrastructure or an isolated VM. Do not run this directly on your local workstation.
Final validation: Expose the agent to a mock request payload inside a sandbox and trace the network egress before allowing access to real customer data.

Contract: missing

curl -s "https://www.xpersona.co/api/v1/agents/clawhub-athola-nm-scribe-doc-generator/snapshot"

Documentation

CLAWHUB

144,847 characters of source documentation, loaded on request.

Extracted files

5 files captured from the source.

SKILL.md

---
name: doc-generator
description: Generates or remediates documentation with human-quality writing
version: 1.9.8
triggers:
  - documentation
  - writing
  - generation
  - remediation
  - polish
  - creating new docs
  - rewriting AI-generated content
  - or applying style profiles
metadata: {"openclaw": {"homepage": "https://github.com/athola/claude-night-market/tree/master/plugins/scribe", "emoji": "\ud83e\udd9e", "requires": {"config": ["night-market.scribe:shared", "night-market.scribe:slop-detector"]}}}
source: claude-night-market
source_plugin: scribe
---

> **Night Market Skill** — ported from [claude-night-market/scribe](https://github.com/athola/claude-night-market/tree/master/plugins/scribe). For the full experience with agents, hooks, and commands, install the Claude Code plugin.


# Documentation Generator

**A document costs the sum of its readers' time. Earn that
cost or cut.**

Generate documents that are grounded in specific claims, lead
with their thesis, and earn every sentence. Filler phrases like
"In today's fast-paced world" and vague descriptors like
"thorough" or "complete" without evidence are bloat. So is
any sentence that does not carry, instance, bound, or repeat
the document's one takeaway.

This skill enforces both **sentence-level cleanliness** (no
slop vocabulary, em dash overuse, or sycophantic openers) and
**document-level economy** (thesis-first, every sentence
earns weight, repetition reserved for the thesis). See
`Skill(scribe:slop-detector)` module `document-economy.md`
for the full rubric.

## Core Writing Principles

Use active voice and an authorial perspective. Explain the
reasoning behind technical choices (why this database, not
that one) rather than presenting neutral boilerplate. Use
bullets sparingly for short, parallel summaries; convert
multi-line bullet waterfalls into prose so the reasoning
survives.

### Vocabulary and Style

Avoid business jargon and linguistic tics like mirrored
sentence structures or em dash overuse. Use the imperative
mood for docstrings ("Validate input", not "Validates").
Do not humanize non-living constructs ("the code wants",
"the function speaks to").

| Instead of | Use |
|------------|-----|
| fallback | default, secondary |
| leverage | use |
| utilize | use |
| facilitate | help, enable |
| comprehensive | thorough, complete |

### 9. Limit Humanizing Constructs

"Lives under," "speaks to," and similar phrases only make sense
for living things.

### 10. Imperative Mood for Docstrings

"Validate" not "Validates" (per PEP 257, pydocstyle, ruff).

## Required TodoWrite Items

1. `doc-generator:scope-defined` - Target files and type identified
2. `doc-generator:style-loaded` - Style profile applied (if available)
3. `doc-generator:content-drafted` - Initial content created
4. `doc-generator:slop-scanned` - AI markers checked
5. `doc-generator:quality-verified` - Principles checklist passed
6. `doc-generator:user-approved` - Final approval received

## Mode: Generatio

_meta.json

{
  "ownerId": "kn7d107jg9jv602h9ytsegydq184a42s",
  "slug": "nm-scribe-doc-generator",
  "version": "1.9.19",
  "publishedAt": 1787750498769
}

modules/generation-guidelines.md

---
module: generation-guidelines
category: writing-quality
dependencies: []
estimated_tokens: 400
---

# Documentation Generation Guidelines

Detailed guidance for creating human-quality documentation.

## Opening Patterns

### What to Avoid

```markdown
BAD: "In today's fast-paced development environment, documentation plays a crucial role..."
BAD: "Welcome to the comprehensive guide to..."
BAD: "This document aims to provide an in-depth overview of..."
```

### What to Use

```markdown
GOOD: "scribe detects AI-generated content and helps you fix it."
GOOD: "Install with: npm install scribe"
GOOD: "This guide covers installation, configuration, and common workflows."
```

Start with what it IS or what it DOES. Skip the preamble.

## Section Structure

### Length Targets

| Section Type | Target Length |
|--------------|---------------|
| Overview | 50-100 words |
| Feature description | 30-60 words |
| Step in guide | 20-50 words |
| API endpoint | 40-80 words |

### Paragraph Guidance

Paragraphs should contain 2-4 sentences on a single topic. If a paragraph exceeds 5 sentences, split it.

One paragraph = one idea.

## Line Wrapping

Wrap prose text at 80 characters per line using hybrid
wrapping. This makes git diffs readable and mobile-friendly.

### Rules (in priority order)

1. Keep sentences on one line if they fit within 80 chars
2. Break long sentences at clause boundaries (after `, ; :`)
3. Break before conjunctions (`and`, `but`, `or`)
4. Break at word boundaries as a last resort

### Exempt from wrapping

Tables, code blocks, headings, frontmatter, HTML blocks,
link definitions, and image references stay on one line.

### Example

```markdown
BEFORE:
The system validates all input against the schema and rejects
malformed requests with a 400 status code, logging the
validation failure for debugging.

AFTER:
The system validates all input against the schema
and rejects malformed requests with a 400 status code,
logging the validation failure for debugging.
```

### Additional formatting rules

- Blank line before and after every heading
- ATX headings only (`#` style, never setext underlines)
- Blank line before every list
- Use reference-style links when inline links push past
80 chars

Full specification: `Skill(leyline:markdown-formatting)`

## Concrete Examples

Every feature claim needs a concrete example:

```markdown
BAD: "The system provides flexible configuration options."

GOOD: "Configure via `scribe.yaml` or environment variables.
Set `SCRIBE_STRICT=1` to treat warnings as errors."
```

## Trade-off Discussions

Include reasoning, not just conclusions:

```markdown
BAD: "We recommend Redis for caching."

GOOD: "We chose Redis over Memcached for its sorted sets,
which power the leaderboard. Memcached would use less memory
but require additional application logic."
```

## Ending Patterns

### What to Avoid

```markdown
BAD: "In conclusion, we have covered the essential aspects of..."
BAD: "We hope this guide has been helpf

modules/quality-gates.md

---
module: quality-gates
category: writing-quality
dependencies: [TodoWrite]
estimated_tokens: 300
---

# Documentation Quality Gates

Checklists and thresholds for documentation quality validation.

## Pre-Commit Checklist

Before finalizing any documentation:

### Content Quality
- [ ] No tier-1 slop words present
- [ ] No vapid openers or closers
- [ ] All claims grounded with specifics
- [ ] Trade-offs explained, not just conclusions
- [ ] Authorial perspective present ("we chose", "our tests showed")

### Structure Quality
- [ ] Em dash count < 3 per 1000 words
- [ ] Bullet ratio < 40% (unless reference material)
- [ ] Sentence length varies (SD > 5 words)
- [ ] Paragraphs 2-5 sentences each
- [ ] No five-paragraph essay structure

### Style Quality
- [ ] Consistent voice throughout
- [ ] Appropriate formality for audience
- [ ] Contractions used if informal tone
- [ ] No emojis (unless explicitly requested)

### Technical Quality
- [ ] File paths verified to exist
- [ ] Commands tested and working
- [ ] Version numbers accurate
- [ ] Links not broken

## Metric Thresholds

| Metric | Pass | Warning | Fail |
|--------|------|---------|------|
| Slop score | < 1.0 | 1.0-2.5 | > 2.5 |
| Tier 1 words | 0 | 1-2 | 3+ |
| Em dashes | < 3/1000 | 3-5/1000 | > 5/1000 |
| Bullet ratio | < 30% | 30-50% | > 50% |
| Sentence SD | > 8 | 5-8 | < 5 |

## TodoWrite Integration

Track quality gate status:

```
doc-generator:quality-content - PASS/FAIL
doc-generator:quality-structure - PASS/FAIL
doc-generator:quality-style - PASS/FAIL
doc-generator:quality-technical - PASS/FAIL
```

## Remediation Required

If any gate fails:

1. Identify specific failures
2. Propose fixes
3. Apply fixes
4. Re-run gates
5. Repeat until pass

## Exceptions

Document exceptions when gates are intentionally skipped:

```markdown
## Quality Gate Exception

**Document**: API-reference.md
**Gate**: bullet-ratio (58%)
**Reason**: Reference documentation requires list format
**Approved by**: [user]
**Date**: [date]
```

## Integration with CI

For automated checking:

```yaml
# .github/workflows/docs-quality.yaml
- name: Check documentation quality
  run: |
    scribe scan docs/
    if [ $? -ne 0 ]; then
      echo "Documentation quality check failed"
      exit 1
    fi
```

modules/remediation-workflow.md

---
module: remediation-workflow
category: writing-quality
dependencies: [Edit, Read]
estimated_tokens: 400
---

# Documentation Remediation Workflow

Step-by-step process for cleaning up AI-generated content.

## Phase 1: Assessment

Run slop-detector and categorize findings:

```markdown
## Remediation Assessment: [filename]

**Slop Score**: X.X
**Word Count**: N

### Critical (fix immediately)
- [ ] Vapid opener at line 1
- [ ] "cannot be overstated" at line 45

### High Priority (fix in this pass)
- [ ] 8 tier-1 slop words
- [ ] Em dash density 7/1000

### Medium Priority (fix if time)
- [ ] Bullet ratio 55%
- [ ] Sentence uniformity

### Low Priority (defer)
- [ ] Minor vocabulary substitutions
```

## Phase 2: User Approval for Major Changes

If remediation requires:
- Deleting entire sections
- Restructuring document flow
- Changing technical content

Always ask:

```markdown
## Major Change Required

The opening section (lines 1-25) is primarily filler with no
technical content. Options:

1. **Delete entirely** - Start at line 26 with actual information
2. **Condense to 2 sentences** - Keep intro but remove fluff
3. **Rewrite** - New opening based on document purpose

Which approach? [1/2/3]
```

## Phase 3: Section-by-Section Editing

For documents over 200 lines, process in sections:

```markdown
## Section 1: Introduction (Lines 1-45)

### Current State
> In today's rapidly evolving technological landscape,
> comprehensive documentation plays a pivotal role in
> ensuring seamless developer experiences...

### Issues
- Vapid opener
- "comprehensive", "pivotal", "seamless" (tier 1/2 words)
- No concrete information in 45 words

### Proposed Revision
> scribe checks documentation for AI-generated patterns
> and provides rewriting guidance. This guide covers
> installation, configuration, and usage.

### Changes
- Removed opener cliche
- Replaced with direct statement
- Cut word count from 45 to 22

Proceed? [Y/n/edit]
```

## Phase 4: Vocabulary Sweep

After structural fixes, sweep for remaining vocabulary:

```bash
# Quick vocabulary check
grep -nE '\b(delve|embark|leverage|utilize|comprehensive)\b' file.md
```

Apply substitutions from shared module:

| Line | Current | Replacement |
|------|---------|-------------|
| 23 | leverage | use |
| 45 | utilize | use |
| 67 | comprehensive | thorough |

## Phase 5: Structural Polish

Final pass for structural issues:

1. **Em dashes**: Replace excessive uses with commas/periods
2. **Lists**: Convert bullet waterfalls to prose
3. **Sentence variation**: Add short/long variety
4. **Contractions**: Add if tone is informal

## Phase 6: Verification

Re-run slop-detector:

```markdown
## Remediation Results

| Metric | Before | After | Change |
|--------|--------|-------|--------|
| Slop score | 4.8 | 1.2 | -75% |
| Tier 1 words | 12 | 0 | -100% |
| Em dash density | 7/1000 | 2/1000 | -71% |
| Bullet ratio | 55% | 30% | -45% |

Status: CLEAN
```

## Docstring Mode

For code files, special handling:

Github ReposUpdated 15h agoRank 70

AionUi

Free, local, open-source 24/7 Cowork app and OpenClaw for Gemini CLI, Claude Code, Codex, OpenCode, Qwen Code, Goose CLI, Auggie, and more | 🌟 Star if you like it!

MCPOPENCLAW

Github ReposUpdated 6mo agoRank 70

activepieces

AI Agents & MCPs & AI Workflow Automation • (~400 MCP servers for AI agents) • AI Automation / AI Agent with MCPs • AI Workflows & AI Agents • MCPs for AI Agents

OPENCLAW

Github ReposUpdated 6mo agoRank 70

cherry-studio

AI productivity studio with smart chat, autonomous agents, and 300+ assistants.