项目文档

这里用于整理自己的项目说明。当前尚未添加实际项目文档；博客中的 我的项目 继续用于项目展示。

建议的目录结构

docs/projects/
├── index.md
└── my-project/
    ├── index.md
    ├── installation.md
    └── configuration.md

一份完整的项目说明

章节	建议包含的内容
项目介绍	项目解决的问题、适用场景、当前状态
快速开始	环境要求、安装步骤、最小可运行示例
使用指南	常用操作、关键功能、注意事项
配置参考	配置字段、默认值、可选值
常见问题	已知问题、排查步骤、反馈渠道
更新记录	版本、变更内容、升级说明

接入现有项目

在对应目录中创建 Markdown 文件，再将入口添加到文档站侧栏。博客项目卡片的链接也可以指向这份项目文档。

可从 编写文档 中复制基础模板开始。