chinese-documentation

Enforce Chinese typographic rules and terminology consistency in technical documentation.

30|2|Updated Mar 3, 2022
One-click install
npx skills add https://github.com/lie5860/ak-guess --skill chinese-documentation-lie5860
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: chinese-documentation
Source: https://github.com/lie5860/ak-guess/tree/main/.agents/skills/chinese-documentation
Command: npx skills add https://github.com/lie5860/ak-guess --skill chinese-documentation-lie5860

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Chinese technical documentation often reads awkwardly due to inconsistent spacing, mixed punctuation, literal machine translations, and unclear terminology choices; this Skill provides clear, practical rules to make docs natural, consistent, and easy to read.

Core Features & Use Cases

  • Typographic rules: Prescribes Chinese-English spacing, number/unit spacing, fullwidth vs halfwidth punctuation, and bracket/quote conventions to improve readability.
  • Terminology & translation guidance: Advises when to keep English terms, when to provide Chinese translations on first use, and how to avoid over-translation.
  • Structure and templates: Offers README and API documentation templates, error/amount conventions, and a prepublish checklist for release notes and developer guides.
  • Use Case: Apply these guidelines to polish a project's README, standardize API docs, or audit release notes to remove machine-translation tone and enforce consistent terminology.

Quick Start

Please proofread and rewrite the following Chinese technical document to follow Chinese typographic rules, consistent terminology, and the provided publication checklist.

Frequently Asked Questions about chinese-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I fix Chinese-English spacing and punctuation issues in technical documentation?

To fix Chinese-English spacing and punctuation in technical documentation, apply consistent typographic rules for mixed text, numbers, and units. This enforces fullwidth and halfwidth punctuation conventions to improve readability and consistency.

What is the best way to handle English terminology translations in Chinese developer guides?

Handling English terminology in Chinese developer guides requires deciding when to keep English terms and when to provide Chinese translations on first use. This approach avoids over-translation and removes awkward machine-translation tone from your docs.

How do I standardize structure for README files and API references in Chinese?

Standardize README files and API references in Chinese by applying predefined templates and structural guidelines. This provides consistent section layouts and error or amount conventions for developer guides and release notes.

Can I audit release notes to remove machine-translation tone and enforce consistent terminology?

Yes, you can audit release notes to remove machine-translation tone and enforce consistent terminology by applying a prepublish checklist. This checklist ensures quality, natural phrasing, and terminology consistency before publication.

Why does Chinese technical documentation often read awkwardly and how can I improve readability?

Chinese technical documentation reads awkwardly due to inconsistent spacing, mixed punctuation, and literal machine translations. Improve readability by enforcing clear typographic rules, terminology handling, and structural templates for natural, consistent docs.