wiki/Tech/software-engineering/技术文档/简介.md

title	description	keywords	tags	sidebar_position	author	date
简介	中文文档写作指南简介	中文 文档 写作指南	软件工程/技术文档	1	7Wate	2023-06-26

引言

本指南规范了一种中文写作风格，主要用于技术文档的编写。素材来源于互联网，为各家中文文案风格指南的综合，旨在对中文技术文档的语言风格、结构样式、内容元素、标点符号、格式排版等方面给出参考规范。我希望本指南的出现能为日后业界标准的建立贡献一点力量。

目的

• 提高中文文案的可读性。
• 统一文档风格，保证组织对外输出形象一致。
• 避免不同的文档作者对同一问题反复作出决策，降低与文档相关的沟通成本。

适用范围

• 为编写中文文档的作者（如产品研发人员、技术写作人员等）提供规范或建议。
• 审校文档过程中争议问题的裁决。
• 也可供软件界面、帮助文档等资料开发人员参考。

使用原则

本指南是一本查询手册，建议初次阅读本指南时，先大致浏览目录章节结构，了解本指南涵盖的内容范围；之后就编写文档时碰到的实际问题，再回头查找相应规范。

标点符号和格式排版

• 合理使用标点符号：标点符号是语言的重要组成部分，合理地使用标点符号能够帮助读者更好地理解文档。
• 格式统一：保持文档的格式统一，例如字体、字号、行间距等。

修订和审查

1. 定期修订：定期修订文档，以保持其准确性和时效性。
2. 多人审查：邀请其他人审查文档，他们可能会发现你可能忽视的错误或者遗漏。

本指南主要针对中文技术文档的编写给出了一系列的规范和建议，包括语言风格、结构样式、内容元素、标点符号、格式排版等方面。我希望本指南能帮助你提高中文文档的编写质量，提高其可读性，同时也能减少与文档相关的沟通成本。