81 lines
3.4 KiB
Markdown
81 lines
3.4 KiB
Markdown
---
|
||
title: 附录资料
|
||
description: 中文文档指南附录资料
|
||
keywords:
|
||
- 中文文档指南
|
||
- 附录资料
|
||
tags:
|
||
- 软件工程/技术文档
|
||
sidebar_position: 7
|
||
author: 7Wate
|
||
date: 2023-06-26
|
||
---
|
||
|
||
针对编写的一系列技术文档，应提供相应的**术语表**和**缩略语表**作为附录资料，方便读者查阅。
|
||
|
||
同时，根据技术文档发布平台的不同，应在阅读文档的醒目处提示读者有关文档的侵权说明、商标说明等信息。
|
||
|
||
## 参考资料
|
||
|
||
[Google Developer Documentation Style Guide](https://developers.google.cn/style/)
|
||
|
||
[PingCAP Markdown 编码规范](https://docs.google.com/document/d/1-uZAzoqRJxufkMfF1sBGogv60-NuR0gjqvihGC-Jprc/edit?usp=sharing)
|
||
|
||
[Microsoft Docs 参与者指南概述](https://docs.microsoft.com/zh-cn/contribute/)
|
||
|
||
[产品手册中文写作规范](http://wenku.baidu.com/view/23cc1a6527d3240c8447efbf.html)
|
||
|
||
[中文技术文档的写作规范](https://github.com/ruanyf/document-style-guide)
|
||
|
||
[豌豆荚文案风格指南](https://docs.google.com/document/d/1R8lMCPf6zCD5KEA8ekZ5knK77iw9J-vJ6vEopPemqZM/edit#heading=h.wwm9rx-11m0cb)
|
||
|
||
[LeanCloud 文案风格指南](https://open.leancloud.cn/copywriting-style-guide/)
|
||
|
||
[Lengoo 简体中文规范指南](https://www.lengoo.de/documents/styleguides/lengoo_styleguide_ZH.pdf)
|
||
|
||
[知乎专栏 - 写给大家看的中文排版指南](https://zhuanlan.zhihu.com/p/20506092?columnSlug=uicircle)
|
||
|
||
[Markdown 书写风格指南](https://einverne.github.io/markdown-style-guide/zh.html#file-extension)
|
||
|
||
[中文文案排版指北](https://github.com/sparanoid/chinese-copywriting-guidelines)
|
||
|
||
[Requirements for Chinese Text Layout 中文排版需求](https://www.w3.org/TR/clreq/#mixed_text_composition_in_vertical_writing_mode)
|
||
|
||
[余光中：怎样改进英式中文？- 论中文的常态与变态](https://open.leancloud.cn/improve-chinese/)
|
||
|
||
正确使用 Tab 和空格：
|
||
|
||
- [缩进与对齐——正确地使用Tab和空格](https://blog.csdn.net/tonywearme/article/details/7061530)
|
||
- [使用tab, 还是空格, 小小编程习惯却有巨大的差别](https://juejin.im/post/59e83382f265da4307026141)
|
||
- [写代码时，缩进使用tab 还是空格？ - 知乎](https://www.zhihu.com/question/19960028)
|
||
|
||
数字：
|
||
|
||
- 《出版物上数字用法》GB/T 15835—2011
|
||
- 《出版物上数字用法的规定》GB/T 15835—1995
|
||
|
||
标点符号：
|
||
|
||
- [《标点符号用法》GB/T 15834—2011](http://openstd.samr.gov.cn/bzgk/gb/newGbInfo?hcno=22EA6D162E4110E752259661E1A0D0A8)
|
||
- 《夹用英文的中文文本的标点符号用法（草案）》
|
||
- [易混标点符号：一字线（—）、短横线（-）、浪纹线（～）](https://zhuanlan.zhihu.com/p/87950176)
|
||
|
||
列表：
|
||
|
||
- [写给初学者的 Markdown 教程](https://jdhao.github.io/2018/09/21/markdown_tutorial_for_beginners/)
|
||
- [英语技术文档中如何正确使用无序列表和有序列表？](https://mp.weixin.qq.com/s/DuEmZLsmpTRpawgPGLPifw)
|
||
- [使用无序列表的 7 项注意](http://colachan.com/post/3548)
|
||
|
||
引号：
|
||
|
||
[为什么在知乎上表引用时，用直角引号（「」）而不是弯引号（“”）？](https://www.zhihu.com/question/19589668)
|
||
|
||
顿号：
|
||
|
||
- [8 例顿号误用解析 - 中国编辑校对网](http://www.bianjiao.net/page139?article_id=149&pagenum=all)
|
||
- [顿号（标点符号）- 百度百科](https://baike.baidu.com/item/顿号/998522)
|
||
|
||
语言文字：
|
||
|
||
《常见语言文字错误防范手册》. 周奇主编. 北京: 中国标准出版社, 2010.
|