write-model-description

Drafts structured HTML model descriptions for mirrored models on Civitai.

7.2k|734|Updated Oct 11, 2022
One-click install
npx skills add https://github.com/civitai/civitai --skill write-model-description
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: write-model-description
Source: https://github.com/civitai/civitai/tree/main/.claude/skills/write-model-description
Command: npx skills add https://github.com/civitai/civitai --skill write-model-description

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Mirrored models on the CivitaiOfficial account often ship with one-line stub descriptions that bury creator credit and omit version details. This Skill produces a complete, properly-credited HTML description ready to paste into the Civitai rich-text editor.

Core Features & Use Cases

  • Structured HTML Output: Generates a lede paragraph, source attribution, "Built by" contributor list, 3-5 bold-labeled feature sections, and a links section using only editor-supported tags.
  • Attribution Enforcement: Ensures original creators are credited near the top with canonical Hugging Face or GitHub links, and that every upstream contributor appears in the credits.
  • Version Verification: Cross-checks which model variants are actually mirrored on the Civitai page so the description matches reality.
  • Use Case: When mirroring a model like Sulphur 2 Base, feed the upstream Hugging Face README and the Civitai page URL to get a 2,000-4,000 character description replacing a 420-character stub.

Quick Start

Draft a CivitaiOfficial model description for this model using its Hugging Face README and Civitai page URL, output as HTML ready for the editor.

Frequently Asked Questions about write-model-description

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write a model description for a mirrored model on Civitai?

Read the upstream Hugging Face README, confirm which versions are mirrored on the Civitai page, then draft a lede, source attribution, contributor list, 3-5 feature sections, and a links section. Output as HTML for the Civitai rich-text editor.

What HTML tags does the Civitai rich-text editor support?

The Civitai editor preserves h3, strong, em, a, code, ul, and ol tags. Descriptions should use only these elements, with H3 headings and bold labels for feature sections.

How long should a CivitaiOfficial model description be?

Aim for 2,000-4,000 characters of HTML. Anything under 1,000 characters is too thin and reads like a stub that fails to credit creators or document versions.

How should original model creators be credited on a mirrored page?

Place a bold attribution sentence right after the lede linking the canonical Hugging Face or GitHub repo, then list every contributor named in the upstream README under a Built by section, including acknowledged funders.

What tone rules apply when writing Civitai model descriptions?

Use plainspoken language with no marketing terms like revolutionary or cutting-edge unless benchmarked. Avoid em dashes, hedge only when honest, and state plainly when an upstream build is not mirrored on Civitai.