Content guidelines

一、文档类型与对应模板

1. 用户指南（面向终端用户）

模板示例（Markdown格式）：

# [功能名称] 使用指南
## 概述
- **功能定位**：一句话说明用途（如“用于实现跨部门审批流程配置”）。
- **适用场景**：列举典型使用场景（如“财务报销、采购申请”）。

## 快速开始
### 前置条件
- Oinone版本 ≥ v6.0.0
- 已安装 [依赖模块]

### 操作步骤
1. **步骤1**：进入功能入口
   - 路径：`控制台 > 流程管理 > 新建流程`
2. **步骤2**：配置流程规则
   ```yaml
   # 示例配置
   nodes:
     - type: approval
       role: finance
3. **步骤3**：保存并发布

2. 技术白皮书（面向开发者/架构师）

3. API文档（面向集成开发者）

二、文档贡献流程

1. 贡献流程图

2. 分步流程说明

步骤1：创建Issue

模板选择：在Gitee/GitHub仓库的Issue页面选择“文档改进”模板。
填写规范：

## 文档类型
[用户指南/技术白皮书/API文档]

## 修改范围
- 新增：[新增文档标题]
- 修订：[原文档路径]

## 需求背景
[如“用户反馈现有审批流程文档缺少截图说明”]

步骤2：认领任务

社区维护者将Issue标记为待认领，贡献者在评论区回复“/assign”认领。
认领后Issue状态变更为进行中，超48小时未提交PR则自动释放。

步骤3：编写文档

分支规则：从main分支拉取新分支，命名格式 docs/[Issue编号]-[简述]（如 docs/#45-auth-guide）。
本地校验：
- 使用Markdown校验工具（如Markdownlint）确保格式合规。
- 运行文档站点生成器预览效果（如VuePress）。

步骤4：提交PR

标题格式：docs: [类型] [简述]（如 docs: 用户指南新增审批流程配置说明）。
关联Issue：在PR描述中标注 Fixes #45。

步骤5：审核与合并

初审（24小时内）：
- 格式检查：表格对齐、代码块语法、无死链。
- 内容检查：技术准确性、术语一致性（如统一使用“模块”而非“组件”）。
终审（48小时内）：
- 核心维护者验证技术细节，必要时要求补充示意图或测试用例。
合并规则：
- 至少1名维护者批准（大型文档需2人）。
- 自动触发CI检查（拼写校验、链接有效性）。

三、审核标准与工具

1. 审核Checklist

类别	标准
准确性	所有技术描述与代码行为一致，无歧义表述
完整性	用户指南需覆盖“前置条件-操作步骤-示例-FAQ”完整链路
可读性	段落长度≤5行，复杂流程配流程图（PlantUML/Mermaid）
国际化	中文文档需提供术语表（中英对照），便于未来翻译

2. 推荐工具

Markdown校验：VS Code插件 Markdown All in One + markdownlint。
绘图工具：PlantUML（流程图）、Draw.io（架构图）。
本地预览：VuePress本地服务器实时渲染。