Files
Alfred/docs/user
lanyuanxiaoyao 34071a421a refactor: 品牌重塑 my-app → Alfred·阿福
将项目从模板标识 my-app 全部替换为产品标识 Alfred·阿福,
去掉所有模板措辞,文档语态转为产品视角。

核心标识替换:
- name: my-app → alfred
- title: My App → Alfred·阿福
- subtitle: Bun 全栈应用 → 智能信息处理中枢
- description: 全栈开发框架 → 基于 AI 的信息综合处理平台
- 日志路径: my-app.log → alfred.log
- 构建产物: dist/my-app → dist/alfred(由 APP.name 自动适配)

文档更新:
- README.md 重写为产品介绍
- docs/README.md 去掉模板段落
- docs/user/ 从模板使用指南改为产品手册
- docs/development/ 标识替换 + 去模板措辞
- openspec/config.yaml 去模板项目描述
- LICENSE 填入 Copyright 2025 lanyuanxiaoyao
2026-05-27 09:38:57 +08:00
..

用户文档

本文档是 Alfred·阿福 的用户使用入口,说明如何安装、配置、部署和排查问题。

适用场景:首次安装、编写配置、生产部署、排查运行问题。

文档索引

文档 内容
usage.md 快速开始、安装配置
config.md YAML 结构、变量语法、server/storage/logging
deploy.md 生产构建、可执行文件运行、运行时配置
troubleshoot.md 常见问题:配置校验、变量解析、构建失败

按任务阅读

任务 建议阅读
首次使用 项目快速开始安装配置
编写配置 配置文件
生产部署 部署故障排查
排查问题 故障排查

用户文档更新规则

  • 安装、配置、快速开始流程变化时,更新 usage.md
  • 配置结构、变量语法、server/storage/logging 字段变化时,更新 config.md
  • 生产构建、可执行文件运行、运行时依赖变化时,更新 deploy.md
  • 常见错误、配置校验、构建失败排查方式变化时,更新 troubleshoot.md
  • 用户文档只解释"如何使用"和"用户能观察到什么",实现细节放入 ../development/