Skip to content

raidenfc/my-skills / source-to-product-doc

source-to-product-doc

Verified

从全栈项目源码梳理业务能力并生成面向运营、商户运营和产品人员的 Markdown 产品文档。用户要求阅读源码、反推产品逻辑、编写运营手册或产品说明书时使用;适用于含前端、后端、数据库、异步任务、配置或既有文档的仓库。

FileKindSize
SKILL.mdskill md6.7 KB
agents/openai.yamlconfig291 B
references/product-document-template.mdmarkdown2.8 KB

references/product-document-template.md

View on GitHub
# 产品文档模板

按实际实现保留章节。不要为凑模板补写未实现的功能。

## 文档信息

```markdown
# {产品名称}产品文档(运营版)

> 本文档依据当前实现梳理,面向 {读者}。
>
> 覆盖范围:{业务域或端}。
> 不覆盖范围:{已确认排除的能力}。
```

## 1. 产品定位与角色

- 产品解决的问题和主要业务模式。
- 平台、商户/主办方、普通用户、管理员等角色的定义。
- 各角色的关键权限和可见范围。

## 2. {业务域名称}

每个业务域按同一顺序写作;没有后台、支付或状态能力时省略相应小节。

### 2.1 概述

- 业务目标、对象、范围和关键术语。

### 2.2 用户端

- 入口与浏览方式。
- 主流程:按用户可观察到的步骤说明。
- 关键限制:资格、数量、库存、时间、金额或资料要求。
- 结果:状态、凭证、通知或后续操作。

### 2.3 管理后台 / 商户端

- 创建、编辑、审核、上下架、配置和查询能力。
- 不同角色的可操作范围。
- 用户端与后台端的差异和约束。

### 2.4 状态流转

| 状态 | 含义 | 触发条件 | 操作者 / 系统动作 | 下一状态或异常出口 |
|---|---|---|---|---|
| {状态} | {业务含义} | {触发} | {角色或任务} | {结果} |

### 2.5 关键规则与边界

| 场景 | 规则 | 限制或例外 |
|---|---|---|
| {场景} | {规则} | {边界} |

## 3. 跨业务通用能力

按实际存在的能力选择:

- 账号、认证、组织、子账号和权限。
- 支付、退款、结算、提现、发票和对账。
- 地址、物流、消息通知、客服和内容审核。
- 协议、隐私、运营配置与数据统计。

## 4. 关键边界速查

| 场景 | 当前规则 |
|---|---|
| {未支付/超时/售后/库存/审核等} | {可执行的业务结论} |

## 5. 术语说明

| 术语 | 面向业务的解释 |
|---|---|
| {术语} | {解释} |

## 写作检查

- 只保留已确认能力和规则。
- 让每个状态、金额、时限和权限结论能回溯至完整实现链路。
- 将技术实现转写为用户可理解的条件、动作和结果。
- 只有硬性校验、约束或状态机支持时才使用“仅可”“必须”“不可”“始终”等绝对词。
- 对压缩、开关、阈值、配置和降级逻辑,写明触发条件;将默认值写为“默认”,不等同于线上唯一配置。
- 将启动时自动创建/修复的数据写为初始化机制,不写成普通用户会遇到的失败场景。
- 对大模型或第三方识别,区分“系统要求/尝试”的结果与“系统已校验、保存或展示”的结果;前者不得承诺准确性。
- 区分当前前台未开放的能力与底层绝对不支持的能力。
- 如需保留未解决的范围问题,停止定稿并向用户提问,而不是写入正文。
slack-gif-creatoranthropics/skillsKnowledge and utilities for creating animated GIFs optimized for Slack. Provides constraints, validation tools, and animation concepts. Use when users request animated GIFs for Slack like "make me a GIF of X doing Y for Slack."Stars: 198kUpdated Claude CodeCodexVerifiedInstall
ponytailDietrichGebert/ponytailLazy senior dev mode for any coding task: the smallest change that fully solves it, and a reply a busy human understands in one read.Stars: 194kUpdated Claude CodeCodexVerifiedInstall
ponytail-debtDietrichGebert/ponytailHarvest every shortcut: comment into one debt ledger, so deferrals get tracked instead of forgotten. One-shot report.Stars: 194kUpdated Claude CodeCodexVerifiedInstall
ponytail-debtDietrichGebert/ponytailList every `shortcut:` comment (and older `ponytail:` ones) as a debt ledger. One-shot report, changes nothing. Use for "ponytail debt", "what did ponytail defer", "list the shortcuts", /ponytail-debt.Stars: 194kUpdated Claude CodeCodexVerifiedInstall