6. Copywriting Rules

Scope

These rules apply to:

  • Package description field (package.json)
  • Each tool's description and guidelines
  • README.md content
  • CHANGELOG.md (auto-generated)
  • CLI output messages

Style Guidelines

  • Use concise and clear sentences (eliminate unnecessary modifiers)
  • One sentence per tool description, within 30 characters recommended (Korean)
  • Avoid nominal endings; use descriptive form
  • Maintain a professional and neutral tone

Package Description Format

Use this skill to [action] via the [package-name] CLI. Handles [main features].

Examples:

  • @julong/mono-rele2-core: "Use this skill to invoke core system utility functions via the mono-rele2-core CLI. Handles message echo, UTC timestamp generation, and environment variable lookup."
  • @julong/mono-rele2-utils: "Use this skill to invoke text utility functions via the mono-rele2-utils CLI. Handles class name merging, case conversion, and text truncation."

Tool Description Rules

  • One sentence, starting with a verb in third-person singular (Returns, Merges, Converts, Truncates, Generates, etc.)
  • Omit the period (for clean display in tool lists)
  • Write result-oriented rather than function-oriented (e.g., "Truncates text to a maximum length" ✓ / "Takes text and truncates it" ✗)

Prohibited Expressions

ProhibitedReasonReplacement
"very", "really", "extremely"Unnecessary emphasisRemove
"simply", "just", "easily"ExaggeratedRemove
"revolutionary", "powerful"Marketing hypeReplace with specific description
Emoji/special charactersCLI/MCP compatibilityProhibited
"Please"Unnecessary in imperative sentencesRemove
Vague units ("a lot of", "some")Lacks precisionSpecify concrete values/conditions

README Documentation Rules

  • Title: Use the package name directly (# @julong/mono-rele2-core)
  • Description: Use the package.json description directly
  • Examples: Focus on working commands with result comments
  • CLI usage: Maintain consistent pattern: npx <package>-cli <toolName> [...args]
  • Installation: Provide both npm and npx methods