📝 文档规范:共建优质学习资源
为确保内容质量与学习体验,我们制定了清晰的文档规范。无论是阅读还是贡献内容,都请遵守以下准则:
- 内容创作规范
- 准确性优先:所有技术概念必须引用权威来源(如官方文档、经典教材),避免主观臆断
- 通俗化表达:用"生活化类比"解释复杂概念(例如:"进程就像餐厅里的一桌客人,CPU是服务员")
- 实例驱动:每个知识点尽量配套可复现的示例(如命令行操作步骤、代码片段、截图说明)
- MDX格式规范(写作必读)
- 标题层级:严格遵循"# 一级标题(仅主页使用)→ ## 二级标题(大章节)→ ### 三级标题(子主题)"的层级,避免标题层级混乱
- 代码块:必须指定语言类型,添加简明注释,示例:
# 正确示例:创建并进入文件夹(含注释)
mkdir my-first-project # 创建名为"my-first-project"的文件夹
cd my-first-project # 进入该文件夹
- 代码规范(实践类内容)
所有代码示例需符合行业通用规范:
- 命名规则:变量/函数名使用英文且有明确含义(禁止拼音或无意义命名如a1/b2)
- 格式统一:Python使用4空格缩进,JavaScript使用2空格缩进,代码块末尾添加运行结果说明
- 安全性检查:涉及文件操作、网络请求的代码必须添加安全提示(如"请勿在生产环境直接运行")
4.提示框的使用
:::tip 💡 学习提示
这里放置学习技巧和经验分享
:::
:::warning ⚠️ 注意事项
这里放置需要特别注意的内容
:::
:::danger 🚨 常见错误
这里放置常见的错误和避免方法
:::
:::info 📚 扩展知识
这里放置相关的扩展知识点
:::