# codex_guide

**Repository Path**: xiaoheaicoding/codex_guide

## Basic Information

- **Project Name**: codex_guide
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: CC-BY-4.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-09-02
- **Last Updated**: 2026-09-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Codex 使用指南

这是一个面向 OpenAI Codex 使用者的中文文档仓库，主要整理：

- Codex 在项目中的工作方式
- 如何为项目准备 `project_brief`
- 如何维护 `project_status`
- 如何给每次任务写清楚指令

## 适合谁看

- 想在本地项目里规范使用 Codex 的个人开发者
- 想把 Codex 作为协作工具的团队成员
- 想要一套轻量、可复用的项目配套文档模板的人

## 当前内容

- [`面向OPC的codex使用指南.md`](/Users/ghhe/Projects/from_github/codex_guide/面向OPC的codex使用指南.md)
- [`docs/project_brief.md`](/Users/ghhe/Projects/from_github/codex_guide/docs/project_brief.md)
- [`docs/project_status.md`](/Users/ghhe/Projects/from_github/codex_guide/docs/project_status.md)
- [`docs/develop_log.md`](/Users/ghhe/Projects/from_github/codex_guide/docs/develop_log.md)

## 建议使用方式

1. 先读主指南，理解四件套的关系。
2. 按 `docs/project_brief.md` 先把项目目标写清楚。
3. 再用 `docs/project_status.md` 记录当前进展。
4. 每次让 Codex 做事时，尽量给出明确范围和验收标准。

## 仓库约定

- 文档优先，避免不必要的复杂结构。
- 尽量保持中英术语一致，便于检索和协作。
- Python 项目统一使用 `uv` 作为包管理器和环境管理工具。
- 如果后续加入示例代码或脚本，再补充对应的使用说明。

## 许可证

本仓库文档内容采用 [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 许可，除非文件内另有说明。