mirror of
https://github.com/primedigitaltech/market-assistant.git
synced 2026-07-21 23:41:39 +08:00
35 lines
1.4 KiB
Markdown
35 lines
1.4 KiB
Markdown
# 文档体系（轻量说明）
|
||
|
||
> 面向协作：哪些材料放哪、命名习惯、与里程碑如何对齐。**不**替代研发内部接口契约（后者单独维护）。
|
||
|
||
## 推荐阅读顺序
|
||
|
||
| 文档 | 用途 |
|
||
|------|------|
|
||
| 项目进展与里程碑 | 一页纸：目标、阶段、优先级 |
|
||
| 流水线单次任务输出说明 | 任务产物、状态、接口能力（偏研发） |
|
||
| OpenAPI 子集 | 可导入 API 调试工具 |
|
||
| 示例数据 | JSON 形状参考 |
|
||
| 演示与脱敏 | 走查步骤、基线模板、样例约束 |
|
||
| 策略类模板 | 人工撰写或对照自动草稿章节 |
|
||
| 工程说明 | 实现上的约束（如任务执行方式） |
|
||
|
||
## 命名与存放
|
||
|
||
- 说明类：文本文档，中文文件名可接受。
|
||
- 大体积数据、含隐私的跑批结果：**勿提交** Git；用内部网盘或对象存储，并在说明里写清获取方式。
|
||
- 对外演示：只用脱敏截图/录屏 + 小规模样例。
|
||
|
||
## 版本与变更
|
||
|
||
- 产品级大变更：在里程碑文档中记一句；若团队使用变更日志，可在仓库根后续追加（当前未强制）。
|
||
|
||
## 常见产出形态
|
||
|
||
- **市场策略制定稿**：策略框架与待填命题；下载或复制后由业务放入 Confluence / Word 再定稿。
|
||
- **竞品简报包**：ZIP，内含报告、结构化摘要、要点摘录等，详见流水线输出说明。
|
||
|
||
---
|
||
|
||
*文档体系说明（Market-Assistant）*
|