Workwork

Workwork - Academic Review Writing & Formatting Assistant

Purpose

This skill provides comprehensive tools for academic review writing and formatting, specifically optimized for Chinese academic standards. It automates reference checking, format validation, document generation, and quality control processes to help researchers produce compliant, professional academic papers efficiently.

When to Use This Skill

Use this skill when:

• Writing or formatting academic literature reviews
• Checking reference list formats and citations
• Validating document structure according to Chinese academic standards
• Generating Word documents with proper formatting
• Filtering references by journal quality (e.g., removing non-core journals)
• Fixing reference numbering and citation consistency
• Proofreading for typos and grammar errors

Core Capabilities

This skill provides ten functional modules accessible through scripts in the scripts/ directory:

1. Literature Integrity Checker ⭐ NEW (CRITICAL)

• Script: literature_integrity_checker.py
• Purpose: Comprehensive validation of reference integrity and citation consistency
• What it checks:
  • Reference completeness (authors, title, journal, year, pages)
  • Citation consistency (all citations have corresponding references)
  • Reference numbering continuity
  • Duplicate references
  • Citation format compliance
  • Invalid/orphan citations
  • Consecutive duplicate citations 🆕 NEW: Detects when the same reference is cited in 3+ consecutive sentences
• Critical Feature: Returns non-zero exit code on critical errors, preventing submission with errors
• Auto-Open Feature 🆕 NEW: Automatically opens the final Word document (your_review_上标版.docx) after successful check (no critical issues)
• Usage:

  # Standard check with auto-open enabled (default)
  python scripts/literature_integrity_checker.py your_review.md
  
  # With deep verification
  python scripts/literature_integrity_checker.py your_review.md --deep-check
  
  # Disable auto-open
  python scripts/literature_integrity_checker.py your_review.md --no-auto-open

• Output: your_review_literature_integrity_report.md
• Note: When check passes (no critical issues), the script automatically searches for and opens your_review_上标版.docx or your_review.docx

2. Unified Checker (RECOMMENDED - Most Efficient)

• Script: unified_checker.py
• Purpose: Run all checks at once in a single operation
• What it does:
  • Reference format validation
  • Citation accuracy checking
  • Typo and grammar detection
  • Document format compliance checking
• Usage:

  python scripts/unified_checker.py your_review.md

• Output: your_review_unified_report.md

3. Reference Formatter

• Script: reference_formatter.py
• Purpose: Validate and format reference citations and bibliography
• What it checks:
  • Citation marker positioning (before punctuation)
  • Author name formatting (adding "等" when exceeding limit)
  • Reference numbering continuity
  • Duplicate reference numbers
  • Figure/table citation markers
• Configuration: Edit templates/ref_format_default.yml for custom rules
• Usage:

  python scripts/reference_formatter.py your_review.md
  python scripts/reference_formatter.py your_review.md custom_config.yml

4. Typo & Grammar Checker

• Script: typo_grammar_checker.py
• Purpose: Detect common typos, grammar errors, punctuation issues
• What it checks:
  • Common Chinese typos
  • Mismatched quotes/brackets
  • Punctuation usage
  • Number formatting
• Usage:

  python scripts/typo_grammar_checker.py your_review.md

5. Reference Accuracy Checker

• Script: reference_accuracy_checker.py
• Purpose: Verify citation validity and reference integrity
• What it checks:
  • Invalid citations (referencing non-existent references)
  • Orphaned references (not cited in text)
  • Reference numbering continuity
  • Citation numbering in text
  • Citation marker positioning
• Usage:

  python scripts/reference_accuracy_checker.py your_review.md

6. Document Format Checker

• Script: document_format_checker.py
• Purpose: Validate document structure and formatting
• What it checks:
  • Main title presence and formatting
  • Abstract and keywords sections
  • Chapter structure and numbering
  • References section
  • Paragraph formatting
  • Heading hierarchy
  • List formatting
• Usage:

  python scripts/document_format_checker.py your_review.md

7. Reference Filter

• Script: filter_references.py
• Purpose: Filter references based on journal quality lists
• What it does: Identifies and removes references from non-core journals
• Setup required: Edit the script's journal lists before running
• Usage:

  python scripts/filter_references.py

8. Reference Number Fixer

• Script: extract_and_fix_references.py
• Purpose: Renumber references and update all citations in text
• What it does:
  • Extracts all references
  • Renumbers them sequentially
  • Updates all citation markers in text
  • Removes invalid citations
• Warning: Directly modifies the source file—backup first
• Usage:

  python scripts/extract_and_fix_references.py

9. Word Document Generator

• Script: create_word_doc_v3.js (Node.js)
• Purpose: Generate Word documents with Chinese academic formatting
• What it produces:
  • Font: SimSun (宋体) for Chinese, Times New Roman for English
  • Font size: 小四 for body, 三号 for headings
  • Line spacing: 1.5倍
  • Margins: 2.54cm
• Requirements: Node.js 14+, docx npm package
• Usage:

  node scripts/create_word_doc_v3.js

10. Word Document with Superscript Citations

• Script: create_word_with_superscript.js (Node.js)
• Purpose: Generate Word documents with superscript reference citations (右上标格式)
• Important: Citation format is [n] (with brackets) in superscript - e.g., [1], [2-3]
• Features:
  • Smart Font Handling: Chinese text uses SimSun (宋体), English/numbers/punctuation use Times New Roman
  • Superscript Citations: Body text citations appear as superscript: [¹], [²⁻³]
  • Italic Scientific Names: Automatically detects and italicizes species Latin names (e.g., Rhinopithecus bieti)
  • Font Size: Body text and references use 小四 (12pt), headings use appropriate sizes
  • Auto-Open: Automatically opens the generated document after creation
• What it produces:
  • Body text citations appear as superscript: [¹], [²⁻³]
  • Reference list entries remain normal format (not superscript)
  • All other formatting same as standard generator
• Requirements: Node.js 14+, docx npm package
• Usage:

  node scripts/create_word_with_superscript.js your_review.md

• Output: your_review_上标版.docx (auto-opens after generation)

11. Citation Pattern Analyzer ⭐ NEW

• Script: analyze_citation_pattern.py
• Purpose: Detect "whole-paragraph citation split into per-sentence annotations" pattern
• What it checks:
  • Same reference cited in 2+ consecutive sentences within a paragraph
  • "Serious" flag for 3+ consecutive sentences
  • "Warning" flag for 2 consecutive sentences
  • Distinguishes valid total-then-detail structures from unnecessary repetition
• Academic rule: When an entire paragraph derives from one source, cite only at the first or last sentence, not every sentence
• Usage:

  python scripts/analyze_citation_pattern.py your_review.md

• Output: your_review_citation_pattern_report.md

For most use cases, follow this 9-step workflow:

Step 1: Write Review

Create your academic review in Markdown format: your_review.md

Step 2: Run Literature Integrity Check ⭐ CRITICAL

这是最重要的检查步骤！ 运行文献完整性检查，确保所有引用和文献都正确无误：

python scripts/literature_integrity_checker.py your_review.md

This takes ~2 minutes and generates your_review_literature_integrity_report.md

⚠️ 重要: 此检查会发现以下严重错误：

• 无效引用（引用编号超出参考文献范围）
• 孤立引用（正文中有引用但参考文献列表中不存在）
• 参考文献编号不连续
• 重复的参考文献
• 文献信息不完整（缺少作者、标题、期刊、年份等）

如果发现严重问题，脚本会返回错误码，阻止继续操作！

Step 3: Run Unified Check

Execute unified checker to run all validations at once:

python scripts/unified_checker.py your_review.md

This takes ~5 minutes and generates your_review_unified_report.md