document-style-guide

This repository is a style guide for writing technical documentation in Chinese. Think of it like a rulebook that shows Chinese tech writers how to format and structure their work so it's clear, consistent, and professional—similar to how English-language publications follow AP Style or Chicago Manual of Style.

The guide covers the practical details that matter when you're writing tutorials, API docs, or technical explanations: how to write titles, structure paragraphs, format numbers and punctuation, organize larger documents, and handle reference links. Each topic has its own section with specific recommendations. For example, it explains whether to use full-width or half-width punctuation, how to handle numbers and units, and how to organize a document's hierarchy so readers can follow your thinking.

If you're a Chinese technical writer, developer advocate, or content manager creating documentation for a Chinese audience, this gives you a standard to follow. Instead of each team deciding their own rules, everyone can reference the same guidelines. This is especially useful for companies or open-source projects that want multiple people contributing to docs without the writing style drifting all over the place. It's also helpful for individual writers who want their work to look polished and professional, or for teams translating technical content into Chinese and wanting it to feel natural.

The README doesn't go into detail about specific rules or examples—it's mainly a table of contents pointing to separate documents. The project is released into the public domain, meaning anyone can use it freely without restriction. With over 12,000 stars, it's become a widely adopted standard in the Chinese tech community.