Back to Details

lint-doc

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Document Linting

文档格式校验（Document Linting）

Workflow

工作流程

1. Target Identification

1. 目标文档识别

Identify the document to check from recent context (recently edited or discussed files). If no clear target, ask user to provide the file path.
从近期上下文（最近编辑或讨论的文件）中确定要检查的文档。如果没有明确的目标，请要求用户提供文件路径。

2. Rule Check

2. 规则检查

Read the target file and check against all document-related rules from 
.claude/rules/
and 
CLAUDE.md
. Apply rules relevant to the document's language (e.g. text formatting rules for Japanese documents).
读取目标文件，并对照
.claude/rules/
和
CLAUDE.md
中的所有文档相关规则进行检查。应用与文档语言相关的规则（例如日文文档的文本格式规则）。

3. Report Findings

3. 检查结果报告

List all violations found with:
  • Line number
  • Violation type
  • Current text
  • Suggested fix
列出所有发现的违规问题，包含以下信息：
  • 行号
  • 违规类型
  • 当前文本
  • 建议修复方案

4. Apply Fixes

4. 修复方案应用

Use AskUserQuestion to present the following options:
  • Auto-fix all - Apply all suggested fixes
  • Review each - Confirm each fix individually
  • Report only - Show violations without fixing
使用AskUserQuestion功能提供以下选项：
  • 自动修复全部 - 应用所有建议的修复方案
  • 逐个审核修复 - 逐一确认每个修复方案
  • 仅生成报告 - 仅显示违规问题，不进行修复

Scope Exclusions

范围排除

Do NOT modify content inside:
  • Backticks (inline code, code blocks)
  • Database values or API responses
  • Quoted text from external sources
请勿修改以下内容：
  • 反引号包裹的内容（行内代码、代码块）
  • 数据库值或API响应
  • 来自外部来源的引用文本