Index of every page on this site: llms.txt
All skills
onmax avatar

/document-writer

@0a85622
Run it yourself

Use when writing blog posts or documentation markdown files - provides writing style guide (active voice, present tense), content structure patterns, and MDC component usage. Overrides brevity rules for proper grammar. Use nuxt-content for MDC syntax, nuxt-ui for component props.

  • 3 files
  • 12.6 KB
  • MIT
  • Updated 3 months ago
  • GitHub
Use this Skill: https://skilld.dev/gh/onmax/claude-config/document-writer

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈74 tokens for metadata: the name and description. ≈1.1k when used: this file. ≈2.1k more on demand in 2 files.

Description uses 3.7% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈298 characters, or 3.7%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

Documentation Writer for Nuxt Ecosystem

Writing guidance for blog posts and documentation following patterns from official Nuxt websites.

When to Use

  • Writing blog posts for Nuxt ecosystem projects
  • Creating or editing documentation pages
  • Ensuring consistent writing style across content

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.

Related Skills

For component and syntax details, use these skills:

Skill Use For
nuxt-content MDC syntax, prose components, code highlighting
nuxt-ui Component props, theming, UI patterns

Available References

Reference Purpose
references/writing-style.md Voice, tone, sentence structure
references/content-patterns.md Blog frontmatter, structure, component patterns

Loading Files

Consider loading these reference files based on your task:

DO NOT load all files at once. Load only what's relevant to your current task.

Quick Reference

Writing Patterns

Pattern Example
Subject-first "The useFetch composable handles data fetching."
Imperative "Add the following to nuxt.config.ts."
Contextual "When using authentication, configure..."

Modal Verbs

Verb Meaning
can Optional
should Recommended
must Required

Component Patterns (WHEN to use)

Need Component
Info aside ::note
Suggestion ::tip
Caution ::warning
Required ::important
CTA :u-button{to="..." label="..."}
Multi-source code ::code-group

For component props: see nuxt-ui skill

Headings

  • H1 (#): No backticks — they don't render properly
  • H2-H4: Backticks work fine

Workflow

  1. Load relevant reference file (writing-style.md for prose, content-patterns.md for structure)
  2. Draft content using active voice and present tense
  3. Apply the checklist below to verify quality — if any item fails, revise and re-check
  4. Verify callout types match intent (note/tip/warning/important)

Example

# Getting Started with Authentication

Nuxt Better Auth provides a simple way to add authentication to your application.
Configure the module in your `nuxt.config.ts` to get started.

::note
Authentication requires a database connection. See the [database setup](/docs/database) guide for details.
::

## Installation

Add the module to your project:

~~~bash [Terminal]
pnpm add @nuxtjs/better-auth
~~~

The module auto-imports the `useUserSession` composable. Access the current user session from any component.

Checklist

  • Active voice (85%+)
  • Present tense
  • 2-4 sentences per paragraph
  • Explanation before code
  • File path labels on code blocks
  • Appropriate callout types
  • No backticks in H1 headings

Source: SKILL.md on GitHub

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No third-party reports yet.

Signed by skilld at 0a85622. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 4 days ago.

Activeupdated 3 months ago

README badge

README badge for onmax/claude-config/document-writer