• Stars
    star
    700
  • Rank 64,671 (Top 2 %)
  • Language
    Python
  • License
    MIT License
  • Created about 4 years ago
  • Updated 5 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

An open-source style guide for writing Chinese technical documents: https://zh-style-guide.readthedocs.io

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

网页浏览地址:https://zh-style-guide.readthedocs.io

本仓库存储的是《中文技术文档写作风格指南》的源文件,欢迎任何人进行贡献!

如何贡献

所有的源文件都存放在 /source 文件夹下:

  • 配置文件为 conf.py 文件
  • 各章节目录为各个 index.rst 文件
  • 各章节页面为各个 xxx.md 文件

如需贡献,请直接修改 /source 文件夹下的相应文件。

为自己的公司创建一份风格指南

你可以点击右上角的 Fork 按钮,将该风格指南克隆到自己的仓库下,接着就可以按需自行修改了。

如果你成功在公司内部推广了这份风格指南,鼓励你在 zh-style-guide 的使用者列表(完善中) 讨论区留下你的足迹。

每位 zh-style-guide 项目的实际使用者,都是社区的宝贵财富。每次与他人的连接,都会产生意想不到的价值!

相关博客文章

微信公众号二维码:阿狍杂谈

欢迎扫码关注我的微信公众号『阿狍杂谈』👉

介绍:我在互联网/IT/开源世界玩大冒险,在英语/心理/哲学世界学真心话。我所有的输赢得失,都在这儿讲给你听 :-)

Repo stars

Stargazers over time

License

MIT

Reference