documentation

star 623

提供项目文档创建和维护的指导,包括PRD、技术规范和用户指南。在处理文档相关任务或需要文档结构建议时调用。

bage2014 By bage2014 schedule Updated 4/26/2026

name: "documentation" description: "提供项目文档创建和维护的指导,包括PRD、技术规范和用户指南。在处理文档相关任务或需要文档结构建议时调用。"

文档规范

本技能为家族树应用项目提供了全面的文档创建和维护指导。

文档结构

docs/
├── CHANGELOG.md          # 项目更新日志(每次核心变更必须更新)
├── product-research/     # 产品研究文档
├── prd/                  # 产品需求文档
├── ui-design/            # UI/UX设计文档
├── implementation/       # 技术实现文档
└── ai-tools/             # AI工具研究和集成

项目更新日志(CHANGELOG)

重要说明

每次进行核心变更时,必须更新 docs/CHANGELOG.md 文档!

更新时机

  • 新增重要功能模块
  • 架构重构或重大设计变更
  • 新增外部集成(如AI服务、第三方API)
  • 安全加固或性能优化
  • Bug修复(关键Bug)
  • 依赖库重大升级

记录格式

## v[x.y.z] (YYYY-MM-DD)

### 新增功能
- 功能描述

### 改进
- 改进描述

### 修复
- 问题修复描述

### 破坏性变更
- 需要注意的变更

版本号规则

  • 主版本号 (x): 重大架构变更,不兼容的API变更
  • 次版本号 (y): 新功能添加,向后兼容
  • 修订版本号 (z): Bug修复和小改进

示例

## v1.2.0 (2026-05-01)

### 新增功能
- 新增 AI 关系预测服务
- 添加用户头像上传功能

### 改进
- 优化数据库查询性能
- 重构认证模块

### 修复
- 修复登录超时问题

关键文档类型

产品研究

  • 市场分析
  • 用户需求
  • 竞争对手分析
  • 市场机会

产品需求文档(PRD)

  • 产品概述
  • 核心功能
  • 用户流程
  • UI设计指南
  • 技术要求
  • 数据模型
  • 非功能需求

UI/UX设计

  • 设计系统
  • 线框图
  • 原型图
  • UI交互设计
  • 用户测试报告

技术实现

  • 后端实现指南
  • 前端实现指南
  • API文档
  • 数据库架构
  • 安全考虑

AI工具集成

  • AI工具研究
  • 工具范式推荐
  • 集成指南
  • 性能考虑

文档标准

格式

  • Markdown语法
  • 一致的标题层级
  • 清晰简洁的语言
  • 正确使用列表和表格
  • 技术内容使用代码块

内容指南

  • 以概述开始
  • 使用清晰、描述性的标题
  • 包含相关的图表和视觉元素
  • 适当提供示例
  • 保持文档之间的一致性

版本控制

  • 使用Git跟踪文档变更
  • 使用有意义的提交消息
  • 定期审查和更新文档
  • 保持文档与代码变更同步

文档工具

  • Markdown编辑器
  • 图表工具(Mermaid, Draw.io)
  • 文档生成器
  • 版本控制系统

最佳实践

  • 尽早并经常文档化
  • 让利益相关者参与文档审查
  • 保持文档更新
  • 使文档易于访问
  • 使用模板保持一致性
  • 包含相关的代码示例
  • 记录边缘情况和限制
  • 每次核心变更后立即更新CHANGELOG

用户文档

  • 安装指南
  • 用户手册
  • 常见问题
  • 故障排除指南
  • 发布说明

技术文档

  • API参考
  • 架构图
  • 数据库架构
  • 部署指南
  • 开发设置

维护

  • 定期文档审查
  • 随着新功能更新文档
  • 核心变更时同步更新CHANGELOG
  • 删除过时信息
  • 根据反馈改进文档
  • 确保文档可搜索
Install via CLI
npx skills add https://github.com/bage2014/study --skill documentation
Repository Details
star Stars 623
call_split Forks 111
navigation Branch main
article Path SKILL.md
More from Creator