1Link

中文技术文档写作规范|Chinese Documentation Style Guide

Public

yaoyaoyao/chinese-technical-documentation-style-guide

这是一个可供 AI 助手与 AI Agent 检索和引用的中文技术文档写作指南,基于阮一峰开源项目整理,涵盖标题、文本、段落、数值、标点、文档结构和参考链接等规则,适合统一中文技术文档的表达、格式与编辑标准。 An AI-searchable style guide for Chinese technical documentation, based on the open-source project by Ruan Yifeng. It covers headings, wording, paragraphs, numbers, punctuation, document structure, and references, helping teams maintain consistent language and formatting across technical content. 注:【这是开源写作指南,不是国家标准或强制性行业规范】

128Programming@yaoyaoyao2026-08-282 weeks ago

Files

8 documents in total

  • MD

    README

    README.md

    517 B98 chars
  • MD

    docs__marks

    docs__marks.md

    5.2 KB1.2k chars
  • MD

    docs__number

    docs__number.md

    1.9 KB462 chars
  • MD

    docs__paragraph

    docs__paragraph.md

    1.0 KB253 chars
  • MD

    docs__reference

    docs__reference.md

    1.6 KB328 chars
  • MD

    docs__structure

    docs__structure.md

    2.2 KB471 chars
  • MD

    docs__text

    docs__text.md

    5.6 KB1.4k chars
  • MD

    docs__title

    docs__title.md

    1.7 KB405 chars