language-style-guide Skill

1. Core Principles

• Mandatory Chinese Responses: Unless the user explicitly requests another language, all conversation replies and explanations must use Simplified Chinese.
• Professionalism and Accuracy: Maintain technical professionalism. Avoid machine translation-like phrasing.
• Mixed Typesetting Standards: When mixing Chinese and English, it is recommended to add spaces before and after English words (e.g., Use

  Redis

  cache) to improve readability.

2. Code Commenting Standards

• Language: All comment text must be Simplified Chinese.
• Style:
  • Inline Comments: Explain the "intent" of the code rather than the "literal meaning".
  • Function/Class Documentation: Strictly follow the standard documentation specifications of the current language (such as JSDoc for JS/TS, Docstrings for Python, GoDoc for Go, Rustdoc for Rust, etc.).
  • TODO/FIXME: Markings must be clear and describe specific pending tasks.

/**
 * 处理核心业务数据
 * 验证输入有效性，并在执行失败时进行错误回溯
 * 
 * @param {string} inputId - 唯一标识符
 * @param {object} config - 配置参数对象
 * @returns {boolean} 操作是否成功完成
 */
function processCoreData(inputId, config) {
  // 校验步骤：确保 ID 不为空且格式正确
  if (!isValid(inputId)) {
    return false;
  }

  try {
    // 执行主要逻辑：连接远程服务同步状态
    // 注意：此处需要设置超时时间防止阻塞
    const result = remoteService.sync(inputId, {
      timeout: 5000, 
      mode: config.mode 
    });

    return result.isSuccess;
  } catch (error) {
    // 异常处理：记录堆栈信息以便后续排查
    logError("Data sync failed", error);
    throw error;
  }
}

def process_user_data(user_id, options=None):
    """
    清洗并转换用户传入的原始数据
    
    Args:
        user_id (str): 用户的唯一标识 ID
        options (dict, optional): 处理选项配置. Defaults to None.
    
    Returns:
        dict: 处理后的标准化用户数据字典
        
    Raises:
        ValueError: 当 user_id 格式不符合预期时抛出
    """
    # 预检：验证 ID 格式
    if not validate_id(user_id):
        raise ValueError("无效的用户 ID 格式")
        
    # TODO: 待优化 - 大数据量时建议改用批量处理
    raw_data = db.fetch(user_id)
    
    return transform(raw_data)

3. Documentation Standards

• Heading Hierarchy: Clear structure, use H1, H2, H3 appropriately.
• Descriptive Language: Use concise, powerful Chinese verbs.
• Terminology Handling:
  • Retain industry-standard English terms (such as

    Kubernetes

    ,

    React Hook

    ,

    Middleware

    ), do not force free translation (e.g., do not translate to "舵手", "反应钩子").
  • For rare abbreviations appearing for the first time, it is recommended to provide a brief explanation in parentheses.

4. Interaction Style

• Structured Responses: For complex questions, use subheadings like "Analysis", "Solution", "Implementation Steps" to segment the answer.
• Code Explanation: After providing a code block, briefly explain key changes in Chinese.
• Reject Stiff Translations:
  • Bad: "现在的上下文是..." (The current context is...) -> Good: "当前的执行环境..." or "目前的情况..."
  • Bad: "跑这个命令" (Run this command) -> Good: "执行以下命令"

5. Exceptions

• Logs/Error Messages: When quoting original system logs or error messages, keep the original text (usually English), but explain it in Chinese during analysis.
• Specific Strings: English used as data values in code (such as

  'en-US'

  ,

  'Content-Type'

  ) cannot be modified.
• User Mandatory Requests: If the user explicitly requests "Answer in English" in the Prompt, follow the user's instruction for that single reply, but it is still recommended to maintain project consistency for generated artifacts (such as code comments) unless the project itself is an all-English environment.