> ## Documentation Index
> Fetch the complete documentation index at: https://docs.newenergycoder.club/llms.txt
> Use this file to discover all available pages before exploring further.

# 新人任务与成长指南

> NEC 新人指南：岗位路线、标签体系、如何认领并完成第一个 good first issue

> 你不需要“很强”才能贡献。你只需要 **从一个标准的小任务**开始。

***

## 岗位路线图（机械 / 硬件 / 软件 / 运营）

> 目标：从入门 → 能做事 → 能独立 → 能带人；每阶段给出可执行产出。

### 机械（Mechanical）

* 入门（1周）：CAD基础；产出：简单二维图
* 能做事（2周）：小机构装配与打印；产出：装配图+3D打印实体
* 能独立（1月）：子系统设计与验证；产出：BOM+装配指导
* 能带人：评审与复盘；产出：评审记录与改进清单

### 硬件（Hardware）

* 入门（1周）：焊接与工具使用；产出：焊接样品+测试记录
* 能做事（2周）：简单驱动与接口；产出：模块demo+接线图
* 能独立（1月）：板级驱动与电源；产出：原理图/BOM/验证日志
* 能带人：规范与Checklist；产出：评审表+标准流程

### 软件（Software）

* 入门（1周）：Python/嵌入式基础；产出：最小Demo运行日志
* 能做事（2周）：模块化开发与测试；产出：单元测试/文档
* 能独立（1月）：子系统集成与调试；产出：日志/脚本/复盘
* 能带人：Code Review与CI；产出：规范与检查项

### 运营（Community/PM）

* 入门（1周）：Issue/PR流程与排期；产出：看板与SOP
* 能做事（2周）：周报/周刊；产出：周刊页面与精选
* 能独立（1月）：活动与合作；产出：活动方案与复盘
* 能带人：机制与治理；产出：治理文档与准则

***

## NEC 标准标签体系

> 目的：让新人能“看标签就知道我能不能做”，让维护者能“按标签快速分流”。

### 新人入口标签

* `good first issue`：新人可做（≤ 2 小时，几乎不需要上下文）
* `help wanted`：需要帮助（≥ 2 小时，可能需要一定上下文）
* `mentor available`：有维护者愿意带（建议给新人更多打标）

### 类型（Type）

* `type:docs` 文档
* `type:bug` 缺陷
* `type:feature` 新功能
* `type:refactor` 重构
* `type:research` 调研/资料整理
* `type:ops` 运营/流程/项目管理

### 技术域（Area）

* `area:embedded` 嵌入式/单片机/RTOS
* `area:ros` ROS/ROS2/micro-ROS
* `area:vision` 视觉/SLAM
* `area:hardware` 嵌硬件/EDA/焊接/驱动
* `area:mechanical` 机械/CAD/3D打印/CNC
* `area:pm` 项管/流程
* `area:community` 社区/内容/宣传
* `area:repo` 仓库结构/CI/模板

### 难度（Difficulty）

* `difficulty:1` 纯新手（可跟着文档做）
* `difficulty:2` 入门（会一点点基础）
* `difficulty:3` 需要一定项目经验
* `difficulty:4` 核心模块（建议维护者带）

### 状态（Status）

* `status:ready` 可以开始
* `status:blocked` 被阻塞（缺信息/等硬件/等人）
* `status:in progress` 正在做（避免重复劳动）
* `status:needs review` 等待评审

***

## 什么是 `good first issue`

满足以下条件的任务，才配叫 `good first issue`：

* ✅ 2 小时以内可完成（新人）
* ✅ 交付标准明确（做完什么算完成）
* ✅ 不需要深上下文（不懂也能按步骤做）
* ✅ 有参考路径（链接到相关文档/文件位置）
* ✅ 不依赖昂贵硬件（最好能本地/仿真完成）

***

## 新人领取任务的标准流程（必看）

### 1) 在 Issues 里筛选

优先找带这些标签的：

* `good first issue`
* `mentor available`（有带教）
* `type:docs`（最稳）

### 2) 认领（避免重复劳动）

在 Issue 下评论一句：

> 我想认领这个任务，我预计在 X 天内提交 PR。

维护者会：

* 给你 `status:in progress`
* 或把你 assign（如平台支持）

### 3) 开分支

分支建议命名：

* `gfi/<issue-id>-short-title`

### 4) 提早开 PR（推荐 Draft PR）

你可以先开一个 Draft PR，把进度贴上来，维护者更容易带你。

### 5) PR 必须包含什么

* 关联 Issue（写 “Fix #xxx” 或者贴链接）
* 简短说明你做了什么
* 本地验证说明（至少写：我跑通了哪个 Demo/检查了哪些文档链接）

***

## NEC 的 `good first issue` 交付标准（统一验收口径）

### 文档类（type:docs）

* ✅ 链接可用（不要 404）
* ✅ 结构清晰（标题/步骤/下一步）
* ✅ 关键步骤可复制运行（命令、路径、输出）
* ✅ 增加了 FAQ/排查（至少 1 条）

### 代码类（type:feature/type:bug）

* ✅ 有最小复现/最小验证
* ✅ 不破坏现有文档与导航链接
* ✅ PR 描述里写清楚“怎么验证”

***

## 新手任务清单（你们可以立刻发成 Issues）

> 下面这些建议你们直接复制成 Issue 标题发出去，并打标 `good first issue`。

### A. 文档类（最推荐）

1. **docs：修正文档常见拼写**（Linux / Founder / EDA / maintainer 等）
   * 标签：`good first issue` `type:docs` `difficulty:1` `area:repo`
   * 验收：全文搜索替换并确认语义正确

2. **docs：把“资料链接表格”整理成 Reference 页面**
   * 标签：`good first issue` `type:docs` `difficulty:2` `area:community`
   * 验收：按“机械/硬件/软件/运营”分类；保留提取码/解压码；加“版权与合规声明”

3. **docs：补齐《新人 60 分钟上手》的 Windows/macOS 指南**
   * 标签：`good first issue` `type:docs` `difficulty:1` `area:repo`
   * 验收：每个平台至少一套可复制命令

4. **docs：为 MicroROS(ESP32)Robot 写 1 页“快速开始索引”**
   * 标签：`good first issue` `type:docs` `difficulty:2` `area:ros`
   * 验收：写清楚“需要什么硬件/软件/预估时间/常见坑”

### B. 仓库维护类（适合愿意学 Git 的新人）

5. **repo：补一个 PR 模板里的检查项（比如文档链接 404 检查）**

6. **repo：为 README 增加本地预览截图**
   * 标签：`good first issue` `type:ops` `difficulty:1` `area:repo`

### C. 轻量代码类（新人可尝试）

7. **demo：给仓库示例脚本增加 `--plot ascii`/`--plot off` 开关**
   * 标签：`good first issue` `type:feature` `difficulty:2` `area:repo`
   * 验收：默认行为不变；新增参数可用

***

## 新人提问方式（能加速解决问题）

复制这个模板发群里/发 Issue：

* 我在跑：`xxx`（贴命令）
* 我的环境：Windows/macOS/Linux + Python 版本
* 我看到的报错：粘贴完整报错（不要只截一行）
* 我已经尝试过：1) xxx 2) xxx