写作原则
- 清晰简洁:使用通俗易懂的语言,避免冗长描述
- 结构化表达:遵循标题分级、列表说明、段落分隔的规范
- 术语统一:技术术语需保持全站一致性,如HTTP状态码的定义
文档格式要求
- 标题层级使用
#
~######
- 代码块需用 ```markdown 语法包裹
- 链接格式:文本
- 引用规范:
- 本地引用:查看结构指南
- 外部引用:MDN Web Docs
语言风格规范
- 中文场景:使用简体中文,避免生僻字
- 英文场景:英文术语需保持首字母大写,如 Markdown_Format
审核标准
✅ 内容需通过:
- 敏感词过滤
- 语法校验
- 逻辑完整性检查
如需进一步了解文档体系设计,请参考技术文档结构规范。