64 lines
3.3 KiB
Markdown
64 lines
3.3 KiB
Markdown
# 文档索引
|
|
|
|
本目录只保留当前项目仍有维护价值的文档入口。文档口径必须服务当前项目真相：企业/团队私有化交付、NAS / Linux 部署、浏览器使用、许可证控制、低维护验收。
|
|
|
|
## 1. 必看入口
|
|
|
|
- `../README.md`
|
|
仓库总说明，先看这里确认项目定位、目录结构、参考源码边界和常用入口。
|
|
- `../AGENTS.md`
|
|
项目规则入口，定义参考源码目录、修改边界和目标环境。
|
|
- `当前工作流.md`
|
|
当前开发、验证、部署和文档维护的基本流程。
|
|
|
|
## 2. 部署与交付
|
|
|
|
- `deployment/部署说明.md`
|
|
主应用标准部署、快速步骤、部署前检查、首装验收、备份恢复和回滚说明。
|
|
- `deployment/多品牌 NAS 与 Linux 交付差异清单.md`
|
|
面向不同 NAS / Linux 客户现场的部署前采集清单。
|
|
- `初次部署与出厂设置指南.md`
|
|
从零安装、系统初始化和恢复出厂流程。
|
|
- `新手用户上手指引.md`
|
|
给普通使用者看的基础操作指引。
|
|
|
|
## 3. 许可证与授权
|
|
|
|
- `许可证服务接入说明.md`
|
|
当前主应用接入 `license-server` 的项目编码、公开接口和联调方式。
|
|
- `其他项目接入许可证系统说明.md`
|
|
给其他项目负责人使用的许可证系统接入说明。
|
|
|
|
## 4. 功能与 API
|
|
|
|
- `api/模板系统API文档.md`
|
|
上传模板、字段和模板系统相关 API。
|
|
- `user-guide/模板系统用户手册.md`
|
|
模板系统的使用说明。
|
|
- `项目目标与目标环境.md`
|
|
项目最终目标、目标客户和部署环境结论。
|
|
|
|
## 5. 内部参考资料
|
|
|
|
- `参考源码功能吸收整理_20260513.md`
|
|
只在需要核对旧参考源码能力边界时阅读；它不是当前产品功能清单，也不是搬旧功能的依据。
|
|
- `商业化地基排查问题清单_20260524.md`
|
|
内部历史整改台账，混有已完成项、待整改项和审计痕迹；只在追问题和核对状态时查看，不作为部署、接入或普通使用手册。
|
|
- `商业化地基8项收口记录_20260530.md`
|
|
本轮按商业化私有交付目标收口的 8 项阶段记录，只在回看本轮收口时查看，不作为默认入口。
|
|
- `客户首装升级坑位排查_20260530.md`
|
|
客户首装、升级、回滚、许可证服务和对象存储的历史排障记录，已被更新验证覆盖，默认看部署说明即可。
|
|
- `商业化首装演练记录_20260601.md`
|
|
飞牛 fnOS 虚拟机上的首装验收记录，用于追溯 Linux/NAS 脚本和真实测试环境结论。
|
|
- `许可证链路安全评估_20260312.md`
|
|
历史安全评估快照，部分条目已被后续代码和部署配置修正；保留作溯源参考，不作为当前整改入口，引用前必须按当前代码重新复核。
|
|
|
|
## 6. 使用原则
|
|
|
|
1. 判断当前项目事实，先看 `../README.md`、`../AGENTS.md` 和当前代码。
|
|
2. 做部署和验收，先看 `deployment/部署说明.md`。
|
|
3. 做 NAS / Linux 私有化交付，先看 `deployment/多品牌 NAS 与 Linux 交付差异清单.md`。
|
|
4. 做许可证联调，先看 `许可证服务接入说明.md`。
|
|
5. 做参考源码功能吸收，先看 `参考源码功能吸收整理_20260513.md`，不要直接搬旧源码。
|
|
6. 旧报告、旧交付材料、旧交接文档和一次性排障记录不作为当前默认入口；内部整改清单只在追问题和核对状态时查看。
|