skillZs
★ LIVE SKILL TAGS ★
>>> LIVE SKILLS INDEX <<<
* OPEN SOURCE *
NO LOGIN, NO TRACKING
※ REAL INSTALL DATA ※
← back to all skills
kubb-labs/kubb73 installs

documentation

Use when writing blog posts or documentation markdown files - provides writing style guide (active voice, present tense), content structure patterns, and SEO optimization. Overrides brevity rules for proper grammar.

How do I install this agent skill?

npx skills add https://github.com/kubb-labs/kubb --skill documentation
view source ↗

Is this agent skill safe to install?

  • Gen Agent Trust Hubpass

    This skill establishes a set of guidelines and structural patterns for writing technical documentation and blog posts within the Kubb ecosystem. It includes writing style requirements, SEO optimization templates, and standard content layouts without any malicious behavior.

  • Socketpass

    No alerts

  • Snykpass

    Risk: LOW · No issues

  • Runlayerwarn

    5/5 files flagged

  • ZeroLeakspass

    Score: 93/100 · 2 sections analyzed

What does this agent skill do?

Documentation Skill

This skill provides comprehensive guidelines for AI coding assistants working on documentation.

When to Use

  • Adding a new plugin, feature, or option
  • Changing plugin behavior or API signatures
  • Fixing bugs that affect code generation
  • Writing or updating functionalities/component/composable documentation
  • Optimizing documentation for search engines

What It Does

  • Create clear, concise, practical documentation optimized for developer experience
  • Optimize content for search engines and developer intent
  • Structure content for maximum scannability and engagement

Writing Standard

Override: When writing documentation, maintain proper grammar and complete sentences. The "sacrifice grammar for brevity" rule does NOT apply here.

Documentation must be:

  • Grammatically correct
  • Clear and unambiguous
  • Properly punctuated
  • Complete sentences (not fragments)

Brevity is still valued, but never at the cost of clarity or correctness.

Available References

ReferencePurpose
../documentation/references/writing-style.mdVoice, tone, sentence structure
../documentation/references/content-patterns.mdUsage patterns, props structure, component patterns
../documentation/references/seo-optimization.mdSEO best practices, titles, descriptions, keywords, FAQs
../documentation/references/humanizer.mdRemove AI writing patterns, add voice and specificity

Load based on context:

Language and Tone

  • Use the US spelling. For example, use license, not licence.

Naming Conventions

  • Use kebab-case: how-to-do-thing.md
  • Be descriptive: multipart-form-data.md not form.md
  • Match URL structure: File name becomes the URL path

Writing Patterns

PatternExample
Subject-first"The useApp composable handles Fabric related logic."
Imperative"Add the following to config.ts."
Contextual"When relying on TypeScript, configure..."

Modal Verbs

VerbMeaning
canOptional
shouldRecommended
mustRequired

Component Patterns (WHEN to use)

NeedComponent
Info aside> [!NOTE]
Suggestion> [!TIP]
Caution> [!WARNING]
Required> [!IMPORTANT]
Multi-source code::: code-group and ends with :::

Headings

  • H1 (#): No backticks
  • H2-H4: Backticks work fine

Links and Cross-References

  • Internal links: Use relative paths: /plugins/plugin-ts/
  • Anchor links: Link to specific sections: /plugins/plugin-ts/#output-path
  • External links: Use full URLs with descriptive text
  • Placement: Add links section at the very end of the document

Images and assets

  • Location: docs/public/
  • Reference: Use relative paths from markdown files
  • Formats: Use optimized formats (webp/png/jpg)
  • Sizing: Keep file sizes reasonable
  • Naming: Use descriptive names: plugin-react-query-example.png

Checklist

  • Active voice (85%+)
  • Present tense
  • 2-3 sentences per paragraph
  • Explanation before code
  • Validate frontmatter syntax
  • Run humanizer pass: remove AI patterns, add voice and specific details

Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.

<a href="https://skillzs.dev/skills/kubb-labs/kubb/documentation">View documentation on skillZs</a>