document-style-guide README

The project's README from github.com/ruanyf/document-style-guide. As one markdown file: README.md.

中文技术文档的写作规范。

目录

  1. 标题
  2. 文本
  3. 段落
  4. 数值
  5. 标点符号
  6. 文档体系
  7. 参考链接

License

公共领域(public domain)

document-style-guide (ruanyf/document-style-guide)

Searching Database…

What is this?This is a style guide for writing Chinese-language technical documentation, covering conventions for titles, text, paragraphs, numbers, and punctuation.
Is this a tool or just a reference document?It is a plain-text reference document (a set of writing rules), not a tool, library, or software.
Is this guide specific to Chinese documentation only, or does it apply to other languages too?It is specifically written for Chinese technical writing conventions, so its rules (like punctuation and number formatting) may not directly apply to documentation in other languages.
What topics does the guide cover?It covers how to write titles, body text, paragraphs, numbers, punctuation, and overall document structure (文档体系), plus a section on reference links.
Who would find this guide useful?Technical writers, developers, and documentation maintainers who write Chinese-language docs and want consistent, standardized style.
Creator
ruanyf
Size
0.1 MB
Stars
13K
Updated
CommitDec 19
Age
10y
Commits · 90 Days