文档体系架构规划 V1.0(占位)
占位说明
原始文件 AlgoDepartment/06_docs/converttool/ref/Xisound-羲音 初创公司文档体系架构规划 V1.0.md 当前为空(0 行)。
本页根据 文档体系搭建.md 纲领 + Stripe/Vercel/GitLab 业界实践预留骨架,具体内容待产品部补齐。
1. 规划范围(待补充)
文档体系应覆盖的六大子系统:
graph LR
A[战略文档]:::cat --> Hub[文档中心]
B[产品文档]:::cat --> Hub
C[技术文档]:::cat --> Hub
D[品牌文档]:::cat --> Hub
E[运营文档]:::cat --> Hub
F[历史归档]:::cat --> Hub
Hub --> Out1[公司官网<br/>docs.xisound.com]:::out
Hub --> Out2[Notion<br/>内部查阅]:::out
Hub --> Out3[PDF<br/>对外交付]:::out
classDef cat fill:#F5F2EA,stroke:#D4A574,stroke-width:2px
classDef out fill:#E8F4F1,stroke:#5DDECF,stroke-width:2px
2. 六大子系统骨架(待填充细节)
| 子系统 | 目标 | 代表文档 | 负责人 | 状态 |
|---|---|---|---|---|
| 战略文档 | 对外融资 / 对内共识 | 产品矩阵、Roadmap、Pitch Deck、白皮书 | 产品部 | 🟡 部分就绪 |
| 产品文档 | 产品说明 / SKU | Spec Sheet、Datasheet、定价手册 | 产品部 | 🔴 待补 |
| 技术文档 | 研发协作 | 架构、API、DSP 算法、协议 | 算法部 | 🟡 旧版存在(old-arch-doc) |
| 品牌文档 | 视觉统一 | 品牌规范、UI 规范、Logo、名片 | 设计部 | 🟢 paper/mkdocs 已成型 |
| 运营文档 | GTM / BD | GTM 策略、BD 一页纸、组织架构、JD | 运营部 | 🔴 待补 |
| 历史归档 | 版本追溯 | 迁移前文档、已弃用方案 | 各部门 | 🟡 部分迁移 |
3. 交付形态
| 形态 | 承载 | 工具链 | 状态 |
|---|---|---|---|
| 豪华 HTML | 公司官网 docs.xisound.com |
MkDocs-Material(本 Demo 验证) | 🟢 Demo 就绪 |
| Notion 兼容版 | 内部查阅、主机厂客户共享 | md-to-notion 转换脚本 |
🔴 未实现 |
| PDF 交付 | 投资人 / 媒体 | MkDocs with-pdf 或 Pandoc |
🔴 未实现 |
4. 待产品部补充的内容
- 文档分类目录的最终版(顶层命名、Slug 规则)
- 每类文档的负责部门与审核流程
- 文档版本命名规则(V1.0 / 2026-05-02 / Sprint 17)
- 保密分级(Public / Internal / Confidential)与访问控制
- 对外发布流程(Draft → Review → Published → Archive)
- 多语言策略(中英是否全量双语?什么时候启用
i18n) - Notion 同步频率与手动/自动策略
- PDF 导出的模板与封面设计
- 搜索增强(是否引入 Algolia DocSearch)
- 访问分析(GA4 / 内部 metrics)
5. 下一步
建议流程
- 产品部以《Xisound 产品矩阵 V1.1》为参考,补齐本文第 2 节表格的负责人与状态
- 算法部盘点
old-arch-doc/与doc_ref/存量文档,按《MD 规范 v1.0》改写后迁入docs/对应子板块 - 运营部 / 设计部按同样流程补齐子系统
- Demo 站点切换到生产域名
docs.xisound.com并接入 CI
附录 · 引用
- 纲领文档:
06_docs/文档体系搭建.md - 权威规范:
converttool/ref/XIYIN-DESIGN-SPEC.mdv1.3 - 本 Demo 源码:
AlgoDepartment/06_docs/site-build/