language-style-guide_skill

Overview

This skill enforces a strict Chinese-language style for interactions, code comments, and documentation while promoting high-quality technical writing. It defines rules for inline comments, function/class documentation, markdown docs, and interaction tone to ensure consistency across projects and languages. The goal is clear, professional Chinese technical content with sensible handling of English terms when necessary.

How this skill works

The skill inspects conversational replies, code comments, and generated documentation to ensure text is written in Simplified Chinese unless the user explicitly requests another language. It validates comment style against language-specific doc conventions (e.g., JSDoc, docstrings, GoDoc) and flags violations like machine-translation phrasing or untranslated Chinese text. It also enforces mixed-language spacing, preserves original system logs or special strings, and recommends how to treat industry English terms.

When to use it

• When you need all developer-facing text in Simplified Chinese for a codebase or community.
• When generating or updating code comments, function/class docs, and inline annotations.
• When producing Markdown docs, READMEs, API specs, or architecture notes intended for Chinese readers.
• During code reviews to enforce consistent Chinese documentation and comment quality.
• When training models or agents to reply in a Chinese-first style unless explicitly instructed otherwise.

Best practices

• Always write human-quality Simplified Chinese; avoid literal machine-translation phrasing.
• Follow the target language’s documentation conventions (JSDoc, Python docstrings, GoDoc, Rustdoc, etc.).
• Keep industry English terms as-is on first mention and provide a brief Chinese explanation if needed.
• In mixed-language text, add a space around English words for readability (e.g., 使用 Redis 缓存).
• Preserve raw system logs or protocol strings in original form and explain them in Chinese.

Example use cases

• Generate code with Chinese docstrings and JSDoc comments for an open-source library targeting Chinese developers.
• Run automated checks during CI to flag non-Chinese comments or poor translation artifacts.
• Create Markdown API docs in Chinese while retaining official English product names like Kubernetes.
• Guide an AI assistant to respond in structured Chinese with sections such as Analysis, Plan, and Steps.
• Standardize TODO/FIXME comments in Chinese with clear, actionable descriptions.