首页
/ 中文技术文档写作风格指南教程

中文技术文档写作风格指南教程

2024-08-24 19:16:43作者:仰钰奇

项目介绍

《中文技术文档写作风格指南》是一个开源项目,旨在为编写中文技术文档提供一套规范和指南。该项目由社区维护,旨在帮助开发者、技术写作者和翻译者创建一致且易于理解的技术文档。

项目快速启动

克隆项目

首先,克隆项目到本地:

git clone https://github.com/yikeke/zh-style-guide.git
cd zh-style-guide

安装依赖

确保你已经安装了必要的依赖,如 Sphinx 和 Read the Docs 插件:

pip install -r requirements.txt

构建文档

使用以下命令构建文档:

make html

构建完成后,可以在 _build/html 目录下找到生成的 HTML 文件。

应用案例和最佳实践

应用案例

《中文技术文档写作风格指南》已被多家公司和开源项目采用,用于规范其技术文档的编写。例如,某大型互联网公司的内部技术文档团队采用了该指南,显著提高了文档的一致性和可读性。

最佳实践

  • 一致性:确保文档中的术语、格式和结构保持一致。
  • 清晰性:使用简洁明了的语言,避免复杂的句子结构。
  • 可读性:合理使用标题、列表和代码示例,提高文档的可读性。

典型生态项目

《中文技术文档写作风格指南》与多个生态项目紧密相关,包括:

  • Sphinx:一个强大的文档生成工具,用于将 reStructuredText 格式的文档转换为多种输出格式。
  • Read the Docs:一个在线文档托管服务,支持自动构建和版本控制。
  • reStructuredText:一种标记语言,用于编写结构化的文档。

这些项目共同构成了一个完整的技术文档生态系统,为中文技术文档的编写和发布提供了强大的支持。

登录后查看全文
热门项目推荐

最新内容推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
154
1.98 K
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
506
42
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
194
279
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
992
395
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
940
554
communitycommunity
本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息
335
11
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
146
191
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Python
75
70