1
0
wiki/Technology/SoftwareEngineering/技术文档/7.附录资料.md
2024-08-30 12:29:55 +08:00

3.4 KiB
Raw Blame History

title description keywords tags author date
附录资料 中文文档指南附录资料
中文文档指南
附录资料
软件工程/技术文档
技术/软件工程
7Wate 2024-08-07

针对编写的一系列技术文档,应提供相应的术语表缩略语表作为附录资料,方便读者查阅。

同时,根据技术文档发布平台的不同,应在阅读文档的醒目处提示读者有关文档的侵权说明、商标说明等信息。

参考资料

Google Developer Documentation Style Guide

PingCAP Markdown 编码规范

Microsoft Docs 参与者指南概述

产品手册中文写作规范

中文技术文档的写作规范

豌豆荚文案风格指南

LeanCloud 文案风格指南

Lengoo 简体中文规范指南

知乎专栏 - 写给大家看的中文排版指南

Markdown 书写风格指南

中文文案排版指北

Requirements for Chinese Text Layout 中文排版需求

余光中:怎样改进英式中文?- 论中文的常态与变态

正确使用 Tab 和空格:

数字:

  • 《出版物上数字用法》GB/T 15835—2011
  • 《出版物上数字用法的规定》GB/T 15835—1995

标点符号:

列表:

引号:

为什么在知乎上表引用时,用直角引号(「」)而不是弯引号(“”)?

顿号:

语言文字:

《常见语言文字错误防范手册》. 周奇主编. 北京: 中国标准出版社, 2010.