ruanyf/document-style-guide
Document Style Guide
This project is a technical writing style guide and comprehensive specification for professional documentation, with a primary focus on standards for Chinese technical prose. It provides a structured framework for organizing document hierarchies, software manuals, and API references to ensure a consistent user experience.
The guide distinguishes itself through detailed linguistic specifications, including rules for integrating English terms into non-English text and precise standards for punctuation, spacing, and grammar tailored for the Chinese language. It also defines quantitative formatting for currency, numeric ranges, and the description of incremental changes.
Broadly, the project covers document architecture through standardized heading hierarchies and file naming conventions, as well as content design strategies for paragraph structuring and external source attribution. It further addresses prose optimization by establishing rules for sentence length, tone, and visual alignment across different character sets.
Features
- Documentation Standards - Provides a comprehensive system for organizing technical documents using a strict four-level heading structure.
- Technical Writing - Provides a comprehensive set of standardized rules for professional technical writing specifically tailored for the Chinese language.
- Chinese Documentation Standards - Provides punctuation, spacing, and grammar standards specifically tailored for professional technical prose in Chinese.
- Document Content Structuring - Organizes technical content into a strict four-level heading system to maintain logical flow and structural consistency.
- Technical Documentation - Establishes consistent rules for structure, punctuation, and tone to ensure professional quality across technical writing.
- Multilingual Integration Standards - Governs the casing and pluralization of English terms when embedded within non-English technical documentation.
- Technical Documentation Frameworks - Provides a structured framework for organizing document hierarchies, software manuals, and API references for a consistent user experience.
- Quantitative Notation Standards - Specifies the use of half-width numerals and precise phrasing to distinguish absolute values from incremental changes.
- Prose Polishing Tools - Improves the readability and clarity of complex technical explanations through sentence structure and paragraph formatting rules.
- Quantitative Specifications - Provides precise specifications for formatting numerical data, currency, and quantitative increments in technical prose.
- Multilingual - Manages the integration of English terms, currency, and numeric formatting within non-English technical documents.
- Punctuation Enforcement - Matches full-width and half-width punctuation marks to quotes and brackets for professional typographic alignment.
- Mixed-Language Spacing Rules - Provides precise spacing rules between different character sets to ensure visual consistency in mixed-language technical text.
- Document Sectioning - Defines a standardized order for arranging documentation sections from introductory guides to API references.
- Currency Formatting Standards - Defines international naming and placement standards for currency symbols relative to numerical values.
- Numeric Range Standards - Defines precise punctuation and unit standards for connecting numeric range limits.
- Quantitative Change Phrasing - Provides phrasing guidelines to distinguish between absolute final values and incremental changes.
- Sentence Structure Guidelines - Sets limits on sentence length and complexity to improve clarity and accessibility in technical text.
- Documentation Sequence Standards - Arranges software documentation sections in a fixed, logical order from introductory guides to granular API references.
- File - Enforces lowercase and hyphen-separated naming conventions for consistent asset resolution across different operating systems.
- Numeric Formatting - Establishes consistency for quantitative data using half-width Arabic numerals and thousands separators.
- Manual Organization Standards - Structures the sequence and hierarchy of software documentation from introductory guides to detailed API references.
- Thematic Paragraph Modeling - Groups technical text into single-topic blocks with lead-in summaries to maximize readability and information retrieval.
