【中文技术文档的写作规范_P02】如何排版文档的段落和书写数值

技术文档Introduction写作指南:从形式主义到项目契约 Introduction是技术文档中首个也是最关键的认知接口,其本质不是背景铺垫,而是定义问题域、锚定成功标准、划定实施边界的轻量级项目契约。它基于真实业务场景与可验证指标(如P95响应时间、基线值、T+1机制),承载领域实体名词、技术约束标签和决策锚点术语等核心信息,直接决定协作效率、交付质量与跨角色对齐效果。在微服务架构、SaaS系统、嵌入式固件升级等多类工程实践中,一份高信息密度的Introduction能显著降低需求返工率、缩短方案设计周期,并成为团队共识的‘总开关’。 阅读详情

通过本文,你将了解到中文技术文档中段落和数值的写法。

段落

原则

  • 一个段落只能有一个主题,或一个中心句子。
  • 段落的中心句子放在段首,对全段内容进行概述。后面陈述的句子为核心句服务。
  • 一个段落的长度不能超过七行,最佳段落长度小于等于四行。
  • 段落的句子语气要使用陈述和肯定语气,避免使用感叹语气。
  • 段落之间使用一个空行隔开。
  • 段落开头不要留出空白字符。

引用

引用第三方内容时,应注明出处。

One man’s constant is another man’s variable. — Alan Perlis

如果是全篇转载,请在全文开头显著位置注明作者和出处,并链接至原文。

本文转载自 WikiQuote

使用外部图片时,必须在图片下方或文末标明来源。

本文部分图片来自 Wikipedia

数值

半角数字

阿拉伯数字一律使用半角形式,不得使用全角形式。

错误: 这件商品的价格是1000元。

正确: 这件商品的价格是 1000 元。

千分号

数值为千位以上,应添加千分号(半角逗号)。

XXX 公司的实收资本为 ¥1,258,000 人民币。

对于 4 位以下的数值,千分号是选用的,比如1000和1,000都可以接受。对于 4 位以上的数值,千分号是必须的。

货币

货币应为阿拉伯数字,并在数字前写出货币符号,或在数字后写出货币中文名称。

$1,000
1,000 美元

英文的货币名称,建议参考国际标准 ISO 4217。

数值范围

表示数值范围时,用~或——连接。参见《标点符号》一节的“连接号”部分。

带有单位或百分号时,两个数字建议都要加上单位或百分号。

132kg~234kg

67%~89%

变化程度的表示法

数字的增加要使用“增加了”、“增加到”。“了”表示增量,“到”表示定量。

增加到过去的两倍
(过去为一,现在为二)

增加了两倍
(过去为一,现在为三)

数字的减少要使用“降低了”、“降低到”。“了”表示增量,“到”表示定量。

降低到百分之八十
(定额是一百,现在是八十)

降低了百分之八十
(原来是一百,现在是二十)

不能用“降低 N 倍”或“减少 N 倍”的表示法,要用“降低百分之几”或“减少百分之几”。因为减少(或降低)一倍表示数值原来为一百,现在等于零。

注意,学习搬运于:https://github.com/ruanyf/document-style-guide

科研图表与文档排版:字号、字体、图尺寸与颜色的专业规范指南 在学术写作与科研可视化中,图表与文档排版是影响成果呈现专业度与可信度的关键因素。其底层逻辑在于通过系统性的视觉规范,高效传递信息并提升沟通效果。从技术原理看,排版涉及信息层级构建、视觉认知引导以及跨媒介适配等核心问题。在工程实践中,正确的排版能显著提升文档的可读性、严谨性及在不同平台(如印刷期刊、学术海报、演示文稿)上的一致性。具体到应用场景,例如在学术论文写作中,需要根据最终输出媒介(印刷或屏幕)精确设置字号、字体、图片分辨率与颜色方案,以确保图表清晰、信息层级分明,并兼顾色盲友好性与黑白打印的可读性。本 阅读详情

相关推荐

AI+LaTeX:科研论文高效写作与排版全流程解决方案

LaTeX作为学术排版的标准工具,以其专业的输出质量和精准的公式排版著称,但复杂的学习曲线限制了其普及。AI内容生成技术通过自然语言处理实现文本自动化创作,正在改变传统写作模式。本文介绍如何构建AI工具链与LaTeX的协同工作流,覆盖文献检索、大纲生成、公式推导等核心环节,通过格式转换中间件实现Markdown到LaTeX的智能转换。该方案特别解决了学术写作中的内容质量控制问题,确保AI生成结果符合学术规范,同时优化LaTeX模板实现自动适应不同期刊格式要求。对于科研工作者,这种技术组合能显著提升论文产出效

weixin_30906185的博客 414

如何写好技术文档 - 排版格式和规范(一)

本文参考谷歌开发文档风格指南、Vue官方文档、React官方文档、掘金小册和阮一峰《中文技术文档的写作规范》,其中排版格式,主要参照Vue、React官网,写作规范部分主要参考阮一峰老师的《中文技术文档的写作规范》。编写技术文档除了排版格式和规范,思路和风格也极为重要,目前一些亲和、幽默的写作风格往往能获得更多的阅读量。技术文档通常使用markdown编写,所以后面的内容都是针对Markdown文档进行排版。同时排版格式和写作规范有很多重合部分,所以放在一篇文章说明。

程序员李林 9403

Mediapipe手势识别实战——基于关节角度计算实现动态手势分类

本文详细介绍了如何利用Mediapipe进行手势识别,通过计算手指关节弯曲角度实现动态手势分类。文章从基础原理出发,讲解了关节角度计算的数学方法,并提供了Python实现代码。同时,还分享了数字手势和OK手势的识别实战经验,以及性能优化和工程实践中的关键技巧,帮助开发者快速掌握实时手势识别技术。

weixin_26891599的博客 403

如何打造优质的技术文档(Technical Documentation)

一份好的技术文档的宗旨是不仅让自己对技术有深刻的理解,同时让别人也能够读明白自己写的内容。目的不同表达的方式也不同。如果是前两者,那么需要考虑到其他人的理解程度以及工作经验的不一致,所以在编写技术文档的整个过程中需要有意识的站在你所针对的人群的角度去编写是很重要的。不同的技术领域,技术文档的整体构架是不一样的。如果你的逻辑非常清晰且强大,只是碍于文字表述上比较弱项,可以去增强自己的图文合并的方式来表达自己想讲的内容。比如去描述一个技术点时,它的理论基础、实现原理、额外的延申、相关的软件或插件的介绍等等。

Unity3D Unreal 1320

ESD镜像解密与转换全攻略:从esd-decrypter到WinNTSetup的完整流程

本文详细解析了ESD镜像的加密特性与压缩优势,并提供了从解密到转换的完整实战指南。核心步骤包括使用esd-decrypter工具解密ESD文件为WIM格式,以及如何结合WinNTSetup进行灵活的系统安装或进一步封装为可引导的ISO镜像,帮助用户高效处理官方Windows安装镜像。

weixin_29207439的博客 451

从零到一:RK3588平台上的星闪模块驱动移植全解析

本文详细解析了在RK3588平台上移植UB37星闪模块驱动的完整流程,涵盖内核配置、设备树适配、驱动编译、功能测试等关键步骤。通过实践指导,帮助开发者掌握星闪技术在嵌入式系统中的集成与应用,提升无线通信模块的开发效率。

qsc90123456的博客 337

程序员如何编写高大上且实用的技术文档

如何编写高大上的技术文档 作为程序员,除了会写代码,能查bug,还要会画图(UML建模)、做PPT(分享、述职等),更重要的是还要能写得出文档,并且能写出高大上的文档。 根据过往的经验,技术文档一般会: 项目文档: 用于开启新项目的整体概要文档,说明项目背景、成员、依赖关系、项目整体排期、里程碑等信息。 部署文档: 介绍网站或系统如何进行部署,搭建运行环境,通常需要说明代码的...

qq_17324713的博客 6785

2026.5.3:Ubuntu26.04下uv所需的环境变量pyproject.toml

本文档提供了Python开发环境的配置指南。主要包括: 设置环境变量(HF_ENDPOINT、UV_PYTHON_INSTALL_MIRROR等) 创建pyproject.toml配置文件,定义项目元数据(名称、版本等) 指定依赖项(torch系列库)及其安装源(PyTorch官方CUDA 12.8镜像) 配置Python版本要求(>=3.13,<3.14) 设置平台限制(Linux/Windows) 该配置适用于需要PyTorch CUDA 12.8支持的项目开发环境搭建。

拥抱具身智能,昇腾Ascend C 587

中文技术文档的规范-段落

段落 原则 一个段落只能有一个主题,或一个中心句子。 段落的中心句子放在段首,对全段内容进行概述。后面陈述的句子为核心句服务。 一个段落的长度不能超过七行,最佳段落长度小于等于四行。 段落的句子语气要使用陈述和肯定语气,避免使用感叹语气。 段落之间使用一个空行隔开。 段落开头不要留出空白字符。 引用 引用第三方内容时,应注明出处。 One man’s constant is anothe...

菜不是原罪 863

【GameFramework框架内置模块】10、本地化(Localization)

本地化(Localization),也就是我们所说的不同地区的语言适配,比如说中文版“你好”,英文版是“Hello”。GameFramework在本地化方面,不仅支持文本的本地化,还支持任意资源的本地化,比如说游戏中释放烟花的特效也可以做出不同地区的版本,使得中文版烟花里面的“新年好”字样的特效,在英文版里面是“Happy New Year”字样的特效。

优快云博客专家,Unity3D高级软件工程师,《Unity 3D从入门到实战》作者。 2299

在iPad上使用Python进行编程

如果你拥有一台iPad,并且想在上面编写和运行Python代码,你会发现iPad提供了一些适用的工具和应用程序来满足你的需求。安装一个Python解释器应用程序,编写和运行Python代码,使用第三方库和模块,以及存储和共享代码,这些步骤将帮助你在iPad上进行Python编程。要在iPad上运行Python代码,首先需要安装一个Python解释器。这些应用程序提供了一个交互式的开发环境,允许你编写、编辑和运行Python代码。一旦你安装了Python解释器应用程序,你可以开始编写Python代码了。

2301_79366435的博客 4625

【中文技术文档的写作规范_P03】如何书写标点符号和控制文档体系

通过本文,你将了解到中文技术文档中标点符号和文档体系的写法。 文章目录标点符号原则句号逗号顿号分号引号括号冒号省略号感叹号破折号连接号文档体系结构文件名 标点符号 原则 (1)中文语句的标点符号,均应该采取全角符号,这样可以与全角文字保持视觉的一致。 (2)如果整句为英文,则该句使用英文/半角标点。 (3)句号、问号、叹号、逗号、顿号、分号和冒号不得出现在一行之首。 句号 (1)中文语句的结尾处应...

极客-多重人格递归 1512

第十六章:载板制造工艺大全

本文详细介绍了IC载板制造的完整工艺流程,主要包括开料、钻孔、孔金属化、图形形成、层压、表面处理、成型和电测8大工序。每个工序都列出了关键参数和质量控制要点,如开料尺寸精度±0.1mm、激光钻孔孔径50-150μm、孔金属化铜厚20-30μm、图形形成线宽15μm±2μm等。文中还特别说明了MSAP工艺和沉金等特殊工艺的详细流程,以及成型精度和电测标准等关键指标。全文通过流程图和参数表格直观展示了IC载板制造的核心工艺和质量要求。

Open 184

中文技术文档的写作规范

本文来自转载,出处为阮老师的官方网站。真心感谢阮老师为我们整理出这么好的资源,同时也希望每个读到这篇博客的同仁从中受益! 作者:阮一峰 日期:2016年10月18日 很多人说,不知道怎么写文档,都是凭着感觉写。 网上也很少有资料,教你写文档。这已经影响了中文软件的发展。 英语世界里,文档非常受重视,许多公司和组织都有自己的文档规范,清楚地规定写作要求,比如微软、MailChi...

weixin_34402090的博客 331

【32】软考软件设计师——算法题(一):分治法与动态规划深度精讲|下午第4题常考满分攻略

本文是《软件设计师·50讲通关|从零基础到工程师职称》专栏第32篇,正式开启**模块四:应用技术(下午题)算法大题专项**,聚焦下午第4道高频必考大题核心两大算法:分治法与动态规划。全文超4000字深度拆解两大经典算法的底层核心思想、算法策略识别技巧、递归边界设计、状态转移方程推导,全覆盖代码填空高频考点、时间复杂度分析、经典题型解题套路;配套可直接默写的递归代码模板、DP状态设计范式、真题完整填空案例,彻底解决考生分不清分治与DP、递归边界写错、状态转移推不出、复杂度算不对四大核心痛点。

专注于人工智能、软件开发、工控自动化、工厂数字化及智能化等领域,希望和大家共同进步! 636

Data-Structures-and-Algorithm-Analysis-in-Java.pdf

作者: Weiss, Mark A. 出版社: Addison Wesley Data Structures and Algorithm Analysis in Java is an “advanced algorithms” book that fits between traditional CS2 and Algorithms Analysis courses. In the old ACM Curriculum Guidelines, this course was known as CS7. This text is for readers who want to learn good programming and algorithm analysis skills simultaneously so that they can develop such programs with the maximum amo...

中文文案排版指南:提升网站气质的开源项目

无论你是否已经研究过技术写作规范,这个项目都能为你提供有价值的参考和指导。提供 Lint 功能,可输出差异或 JSON 结果以便集成至 CI 环境 (如 GitLab CI、GitHub Action、Travis CI...),从而能够检测代码中存在问题的文本内容,并达到统一规范效果。提供 Lint 功能,可输出差异或 JSON 结果以便集成至 CI 环境 (如 GitLab CI、GitHub Action、Travis CI...),从而能够检测代码中存在问题的文本内容,并达到统一规范效果。

开源服务指南 282

LinePhone3.2.7(android端最新版本) sip客户端

SIP客户端For android:LinePhone3.2.7(最新版本),官网地址:http://www.linphone.org/

Word排版进阶 - 活用标尺与段落设置,精准掌控中文缩进

本文详细介绍了Word中活用标尺与段落设置来精准掌控中文缩进的技巧。通过标尺的直观调整和段落对话框的精确控制,解决中文文档排版中的首行缩进、悬挂缩进等常见问题,提升排版效率与专业性。

weixin_33676492的博客 437

android 蓝牙通讯demo

android 下蓝牙通讯demo,实现了发现蓝牙,使能蓝牙,通过蓝牙发送消息。

jdk-8u144-linux-x64.tar.gz.

该资源为搭建Linux系统Java环境用,资源的后缀为tar.gz格式的压缩包

DeepSeek-OCR-2效果展示:小字号密集排版技术文档→段落缩进/列表层级100%还原

本文介绍了基于DeepSeek-OCR-2开发的智能文档解析工具,该工具能够精准还原小字号密集排版技术文档的段落缩进与列表层级。用户可在星图GPU平台上实现该镜像的自动化部署,快速搭建本地文档处理环境,高效应用于技术手册、学术论文等复杂排版文档的电子化与结构化提取场景。

weixin_35677363的博客 150

使用LaTeX撰写AnythingtoRealCharacters2511技术文档指南

本文介绍了如何在星图GPU平台上自动化部署【动漫转真人】AnythingtoRealCharacters2511镜像,高效实现动漫角色到真实人像的图像转换。该镜像专为风格迁移优化,适用于游戏IP衍生内容制作、虚拟偶像形象生成等典型AI图像应用,显著提升跨模态视觉内容生产效率。

weixin_35696112的博客 413

技术文档工程化规范:角色标注、动作三要素与决策快照

技术文档是软件协作的隐性契约,其质量直接决定信息转译效率与执行可靠性。从基础概念看,规范本质是降低认知负荷的结构化表达系统;原理上需锚定读者角色、动作条件与验收标尺三大维度;技术价值在于将模糊指令转化为可验证、可逆、可审计的工程资产;典型应用场景覆盖API文档、故障排查指南、部署Checklist及功能接入说明等所有需被他人执行的技术内容。本文聚焦【角色标注】与【动作三要素】两大核心热词,提供可嵌入CI流程、适配多角色认知层级、支持环境变量注入的轻量级落地框架。

weixin_34211761的博客 391

Qwen3-0.6B-FP8智能助手:支持思考过程可视化的技术文档写作工具

本文介绍了如何在星图GPU平台上自动化部署Qwen3-0.6B-FP8智能助手镜像,该工具是一款支持思考过程可视化的技术文档写作AI。用户可借助该平台快速搭建环境,利用该镜像高效生成API文档、技术方案等,实现透明、可控的AI协作写作,显著提升技术文档的创作效率与质量。

weixin_35516273的博客 354

Sqribble文档操作系统:模板即规则,排版即工程

文档自动化不是简单的一键生成,而是将出版规范、排版逻辑与内容结构封装为可执行的系统化能力。其核心在于‘模板即代码’的确定性渲染机制——通过网格系统、样式继承链与组件化元素,实现跨平台像素级一致的PDF输出。这种规则驱动的文档操作系统,本质上是面向市场专员、技术文档工程师和独立讲师等高频产出者的轻量级出版基础设施,解决的是批量交付中格式错乱、版本不一、协作低效等工程化痛点。它不替代内容思考,但将专业排版从艺术经验升维为可复用、可验证、可集成的技术流程。

weixin_31421613的博客 280

数学建模竞赛论文写作与排版实战指南:从LaTeX工具到核心模块精讲

在学术研究与工程实践中,清晰、规范的文档写作是传递思想、展示成果的关键。其核心在于遵循严谨的逻辑结构,并借助高效的工具实现专业排版。LaTeX作为学术写作的事实标准,通过标记语言分离内容与格式,能自动管理公式、图表和参考文献,确保文档的一致性与印刷级质量,尤其适合处理包含大量数学公式的长文档。在数学建模等限时团队竞赛中,文档质量直接决定了模型价值能否被评委准确理解与认可。本文聚焦数学建模论文的实战写作,深入剖析了基于LaTeX(特别是Overleaf云端协作)的高效工作流,并详细讲解了摘要、公式、图表等核心

weixin_33966095的博客 619

从代码高亮到视觉叙事:Word中代码块的创意排版艺术

本文探讨了Word中代码块的创意排版艺术,从代码高亮到视觉叙事,提升技术文档的专业性和美观度。通过字体配置、色彩方案、边框设计等技巧,无需插件即可实现专业级代码展示。文章还提供了学术和竞赛场景下的优化建议,帮助读者在论文和竞赛文档中获得更高评分。

weixin_29199873的博客 807
上一篇: 【中文技术文档的写作规范_P01】如何写标题和文本
下一篇: 【中文技术文档的写作规范_P03】如何书写标点符号和控制文档体系
ALGO阿狗
博客等级 码龄9年 64粉丝 149原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值