Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Coding-Rules — 企业级微服务代码规范

面向 LLM Agent 的结构化知识库,基于 Andrej Karpathy LLM Wiki 理念构建。


📚 Wiki 结构

Coding-Rules/
├── CLAUDE.md              ← 🧠 Schema:LLM 操作手册(必读)
├── README.md              ← 📍 本入口文件
├── raw/                   ← 📄 原始资料(只读)
│   ├── MICRO_SERVICE_SPEC.md
│   ├── DEPLOY_TROUBLESHOOTING.md
│   └── docker-proxy-notes.md
└── wiki/                  ← 📖 LLM 维护的知识层
    ├── index.md           ← 目录
    ├── log.md             ← 变更日志
    ├── concepts/          ← 概念页
    │   ├── docker-best-practices.md
    │   ├── microservices-architecture.md
    │   └── coding-standards.md
    └── entities/          ← 实体页
        ├── resume-rag-service.md
        └── docker-proxy.md

🚀 快速开始

你是 LLM Agent?

  1. 首先读取 CLAUDE.md — 这是你的操作手册
  2. 然后读取 wiki/index.md — 了解 Wiki 导航
  3. 根据任务需要,深入 wiki/concepts/wiki/entities/ 查找相关知识

你是人类?

直接浏览 wiki/ 目录,或使用 Obsidian 打开整个仓库,利用图谱视图查看知识结构。


📖 文档速查

原文档 说明 Wiki 对应
MICRO_SERVICE_SPEC.md 微服务规范主体 wiki/concepts/microservices-architecture.md, wiki/concepts/coding-standards.md
DEPLOY_TROUBLESHOOTING.md 部署踩坑记录 wiki/concepts/docker-best-practices.md, wiki/entities/resume-rag-service.md
docker-proxy-notes.md Docker 代理笔记 wiki/entities/docker-proxy.md

🔄 LLM Wiki 工作流

Ingest(摄入新知识)

  1. 读取原始文档
  2. 与用户讨论关键要点
  3. 更新 wiki/ 相关页面
  4. 追加 log.md 记录

Query(问答)

  1. 读取 index.md 定位相关页面
  2. 综合生成带引用的回答
  3. 有价值的输出归档回 Wiki

Lint(健康检查)

  • 检查矛盾、过时、孤儿页面
  • 补全缺失的交叉引用

🎯 建设原则

知识不复利消失。 每次 Q&A 的有价值输出,都会归档回 Wiki。

  • 矛盾主动标注
  • 定期健康检查
  • Schema 持续迭代

最后更新:2026-05-16

About

LLM wiki实践

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors