跳到正文

规范来源与延伸阅读

按写作、中文排版、渲染和协作任务找到可核对的参考资料。

中文技术写作

《中文技术文档写作风格指南》按语言风格、文档结构、内容元素、标点、命名与语法组织写作规则。可以用其中的案例核对改写后的句子是否清楚具体。

阮一峰的中文技术文档写作规范提供标题、段落和文档体系的约定,可用于检查一份长文的组织方式。

校对中文排版

W3C 的《中文排版需求》介绍了标点定位、换行约束和中西文混排。阅读时注意它涵盖不同地区和排版场景。本指南选择常用的简体中文网页正文写法,具体使用约定见中文排版。

中文文案排版指北给出了中西文空格和专有名称的录入方式,可结合本指南的混排示例检查源文件。

核对渲染和无障碍

遇到代码围栏、链接和标题的歧义时,查阅 CommonMark 规范对语法的定义。表格属于常用扩展,可用 GFM 表格说明核对管道和列分隔符。在本站加入交互内容时,可参考 Nuxt Content 的 Markdown 与 MDC 说明。

为图像补充替代文本时,可用 W3C 的图像替代文本决策树判断图像在页面里的用途。实际替代文本随读者任务而变化。

组织文档与协作流程

需要了解其他项目如何分工时,可以查阅 Astro 的 AD² 贡献指南中关于提交、审阅和版本更新的做法。

在引用处标明适用范围

写入项目的默认值、操作和版本前,核对项目本身的可验证来源。引用原话或外部说明时,用引用与参考资料规范交代出处和适用范围。