A reusable writing skill addresses common pitfalls in Chinese technical documentation and product copy, such as vagueness, promotional language, and poor readability with mixed scripts. It targets engineers and technical writers seeking to improve accuracy, conciseness, and clarity in Chinese technical content, offering a direct-use standard or reference.

How It Works

This project provides a curated set of rules focused on high-frequency issues in Chinese technical writing. Key principles include standardizing Chinese quotation marks to 「」, avoiding direct address terms (你, 您, 同学), implementing proper spacing between Chinese, English, and numbers, and eschewing mechanical translations of common English status words. It also discourages internet jargon and ensures button copy reflects user actions, prioritizing mobile readability. This rule-based approach offers a concrete method for enhancing consistency and quality.

Quick Start & Requirements

Installation into a "Codex" environment is recommended via Git clone:

CODEX_HOME="${CODEX_HOME:-$HOME/.codex}"
mkdir -p "$CODEX_HOME/skills"
git clone --depth 1 --branch <release-tag> https://github.com/Fenng/tech-doc-style-chinese.git "$CODEX_HOME/skills/tech-doc-style-chinese"

Development can use a direct directory copy. A zero-dependency Python linting script (scripts/lint_copy_rules.py) is available for local checks. Official documentation is available in NoCode-Skill.md.

Highlighted Details

• Core Rules: Enforces specific Chinese quotation marks 「」, prohibits direct address terms (你, 您, 同学), mandates correct spacing for mixed language/numeric text, and discourages jargon like "赋能" or "抓手".
• Linting Script: Includes a zero-dependency Python script for automated checks on quotes, address terms, term capitalization (e.g., id, http), specific abbreviations (JS, H5), AI terminology (llm, aigc), and common Chinese typos.
• Project Overrides: Supports project-specific conventions (versioning, branding, terminology) via separate override files (e.g., references/Project-Overrides.md), maintaining core skill reusability.
• CI Integration: Features a GitHub Actions workflow (.github/workflows/skill-lint.yml) for automated linting on pull requests and pushes.

Maintenance & Community

No specific details regarding maintainers, sponsorships, or community channels (like Discord/Slack) are provided in the README.

Licensing & Compatibility

The project is released under the MIT License, which is permissive and generally suitable for commercial use and integration into closed-source projects.

Limitations & Caveats

This skill is not intended for machine-readable identifiers such as code literals, JSON keys, URLs, API paths, or database field names. Its primary application is within a "Codex" environment, although the linting script offers standalone utility for style checks.