Skip to content

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

知识库使用说明

定位

本知识库是 Auto-Picture 项目的核心文档体系,供开发者(包括 AI 助手)快速了解项目功能、架构和开发历史。

目录结构

docs/
├── INDEX.md        # 总索引 — 一切从这里开始
├── README.md       # 本文件 — 知识库使用规范
├── 项目概述/        # 项目背景、目标、运行环境
├── 架构设计/        # 系统架构、Agent 设计、协议规范
├── 功能模块/        # 各功能模块的详细文档
├── 部署运维/        # 部署流程、配置说明、运维手册
└── 开发计划/        # 按日期归档的开发与修复记录

使用规范

  1. 查阅顺序:先读 INDEX.md,再按需深入具体文档
  2. 开发记录格式开发计划/<M.DD>修复<序号>/fix_plan.md,内容包括:问题描述、根因分析、解决方案、影响文件、测试结果
  3. 更新时机:每次代码变更后必须同步更新相关文档
  4. 新增文档:添加后必须在 INDEX.md 中注册链接

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages