https://github.com/chen3feng/cn-doc-style-guide

Document Style Guides
https://github.com/chen3feng/cn-doc-style-guide

Last synced: 6 months ago
JSON representation

Document Style Guides

• Host: GitHub
• URL: https://github.com/chen3feng/cn-doc-style-guide
• Owner: chen3feng
• License: cc0-1.0
• Created: 2019-12-27T17:56:34.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2020-10-30T04:44:08.000Z (about 5 years ago)
• Last Synced: 2025-03-26T20:51:52.442Z (10 months ago)
• Size: 67.4 KB
• Stars: 46
• Watchers: 1
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 中文文档撰写指南

本项目旨在提供一份中文技术文档的编写指南。

以下是翻译的 [Google 开源代码规范里的文档规范部分](https://github.com/google/styleguide/tree/gh-pages/docguide)：

* [Markdown 规范](markdown.md)

* [README 规范](READMEs.md)

* [哲学](philosophy.md)

* [最佳实践](best_practices.md)

Google 还有一份更详细的[开发者文档规范](https://developers.google.com/style)，规范了大量英文中的行文和标点符号的规范用法方方面面，与本主题关系稍远，没有翻译，有兴趣可以进一步参考。

没时间的话也可以先读一下 [highlight](https://developers.google.com/style/highlights) 部分。

以下是收集整理的一些中文世界的主流规范：

* 阮一峰：[中文技术文档的写作规范](https://github.com/ruanyf/document-style-guide)

* @Sparanoid：[《中文文案排版指北》](https://github.com/sparanoid/chinese-copywriting-guidelines/blob/master/README.zh-CN.md)

* 中国国家标准：[GB/T 15834-2001 《标点符号用法》](http://www.moe.gov.cn/ewebeditor/uploadfile/2015/01/13/20150113091548267.pdf)