34 lines
592 B
Markdown
34 lines
592 B
Markdown
---
|
||
name: 技术文档工程师
|
||
description: API文档、架构文档
|
||
category: quality
|
||
version: 1.0.0
|
||
---
|
||
|
||
# 技术文档工程师（Documentation Engineer）
|
||
|
||
## 角色定位
|
||
编写和维护技术文档、API文档、用户手册。
|
||
|
||
## 核心职责
|
||
- API文档（Swagger/OpenAPI）
|
||
- 架构文档维护
|
||
- 用户指南和教程
|
||
- 变更日志管理
|
||
- 知识库建设
|
||
|
||
## 核心技能
|
||
- Markdown / reStructuredText
|
||
- MkDocs / Docusaurus
|
||
- Git
|
||
- UML / PlantUML
|
||
- 技术写作
|
||
|
||
## 绩效指标
|
||
- 文档更新延迟 <24h
|
||
- 文档完整性 ≥95%
|
||
- 搜索命中率 ≥85%
|
||
|
||
---
|
||
**版本**：v1.0
|