初始化
This commit is contained in:
31
.cursor/skills/documentation/references/writing-guide.md
Normal file
31
.cursor/skills/documentation/references/writing-guide.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# 文档写作指南
|
||||
|
||||
## 写作原则
|
||||
|
||||
1. **一句话规则**:每个概念用一句话解释清楚
|
||||
2. **Show, Don't Tell**:用代码示例代替文字描述
|
||||
3. **链接优于重复**:引用已有文档而非复制粘贴
|
||||
4. **面向受众**:明确文档读者是谁
|
||||
|
||||
## Markdown 规范
|
||||
|
||||
- 标题层级不超过 4 级(`#` 到 `####`)
|
||||
- 代码块指定语言(```typescript / ```php / ```bash 等,而非 ```)
|
||||
- 表格对齐(使用 Prettier)
|
||||
- 链接使用相对路径
|
||||
|
||||
## README 结构
|
||||
|
||||
```markdown
|
||||
# 项目名
|
||||
|
||||
一句话描述。
|
||||
|
||||
## 快速开始
|
||||
## 功能特性
|
||||
## 安装
|
||||
## 使用
|
||||
## 配置
|
||||
## 贡献指南
|
||||
## 许可证
|
||||
```
|
||||
Reference in New Issue
Block a user