# yikeke/zh-style-guide

An open-source style guide for writing Chinese technical documents: https://zh-style-guide.readthedocs.io

Repository: https://github.com/yikeke/zh-style-guide
Canonical: https://ross.abutalabs.com/products/zh-style-guide
Homepage: https://zh-style-guide.readthedocs.io
Language: Python
License: MIT
License Family: permissive
Topics: style-guide, readthedocs, technical-documentation, hacktoberfest
Last push: 2025-01-06T03:56:20+00:00

## Health v2 (maintenance only)
Score: 32/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 0, release rhythm 35, longevity 100
- inputs: {"age_days": 2177, "days_push": 604, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: no_releases
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1033, forks 95 (observed 2026-08-28T04:03:18.409889+00:00)

## What it is
An open-source style guide for writing Chinese technical documents, published as a Sphinx-based website on Read the Docs. The repository stores the source files (Markdown and reStructuredText) and welcomes community contributions and forks for company-internal customization.

## Use cases
- write consistent Chinese technical documentation
- find Chinese translation conventions for tech terms
- create a company style guide for Chinese docs
- learn punctuation and formatting rules for Chinese technical writing
- set up a Sphinx documentation site on Read the Docs

## When to choose
- you write or review Chinese technical documentation and need consistent style rules
- you want a forkable base for an internal Chinese writing style guide
- you need a reference for translating English tech terms into Chinese

## When to avoid
- you need a style guide for English or other languages
- you need an automated linter that enforces style rules programmatically
- you need actively maintained content - the project is seeking a new maintainer

## Facets
- artifact type: learning-resource
- maturity: maintenance
- function: documentation, markdown
- domain: documentation, developer-tools
- platform: python, cli
- tags: style-guide, chinese-technical-writing, sphinx, readthedocs, writing-standards, localization, web-server

## Member repositories
- yikeke/zh-style-guide (main) score 32

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:03:18.409889+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T07:06:42.578769+00:00, confidence not recorded.
  - readme: https://github.com/yikeke/zh-style-guide (fetched 2026-08-28T04:03:18.409889+00:00, sha 9063ff8301a5)
- Data as of 2026-08-30T08:39:29.467469+00:00.