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…

Что это?Это руководство по стилю для написания технической документации на китайском языке. Оно описывает правила оформления заголовков, текста, абзацев, чисел и знаков препинания.
Это инструмент или просто справочный документ?Это справочный документ в виде обычного текста (набор правил написания), а не инструмент, библиотека или программа.
Это руководство только для документации на китайском языке или оно подходит и для других языков?Руководство написано специально для правил технического письма на китайском языке, поэтому его правила (например, для знаков препинания и оформления чисел) могут не подходить напрямую для документации на других языках.
Какие темы освещает руководство?Руководство описывает, как оформлять заголовки, основной текст, абзацы, числа и знаки препинания, а также общую структуру документации. Кроме того, в нём есть раздел о справочных ссылках.
Кому будет полезно это руководство?Техническим писателям, разработчикам и тем, кто поддерживает документацию, пишет её на китайском языке и хочет единого стандартизированного стиля.
Creator
ruanyf
Size
0.1 MB
Stars
13K
Updated
CommitDec 19
Age
10y
Commits · 90 Days