Dsh Chinese Docs

撰写中文技术文档时使用:术语、排版、代码块与引用规范。

hackerFish 3671420 787 B Updated

File contents

中文技术文档规范

术语

  • 专有名词首次出现保留英文并给出中文:plugin(插件)、preset(预设)、profile、bundle、patch(补丁层)
  • 全篇用词一致:同一概念不中英混用

排版

  • 中文与英文、数字之间留一个空格:"12 个技能""DSH 版本"
  • 代码、命令、文件名一律代码块或行内代码
  • 命令代码块标注语言,涉及版本行为时注明版本号

事实与引用

  • 只写验证过的事实;没验证的写"未验证",不写"应该可以"
  • 引用他人内容注明来源;翻译需确认许可
  • 危险操作(如 curl | bash)必须附安全提醒

hackerFish/awesome-dsh-skills/tree/main/skills/dsh-chinese-docs commit 3671420020

Frequently asked questions

npx skillmds@latest add hackerfish/dsh-chinese-docs