Skip to content

Commit 3731c93

Browse files
yangzhaohuiclaude
andcommitted
精简 README:收敛重复的目录链接列表
目录清单原在 README 出现四处:「零·哪些文件夹给你用」表、「三·项目概览」 进一步查看列表、「九·(三)」优先查看列表、「九·(三)」带注释 tree。后三份都是 维护者视角,且 tree 每行已带注释、信息最全。 - 删「三·项目概览」5 条目录链接,改为指向「九·(三)」tree - 删「九·(三)」tree 上方重复的 8 条目录链接,直接进 tree 保留读者视角的「零」表与唯一完整的 tree。build_all --check / pytest / ruff 全过。 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent d982a79 commit 3731c93

1 file changed

Lines changed: 8 additions & 71 deletions

File tree

README.md

Lines changed: 8 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -8,40 +8,15 @@
88

99
不确定从哪开始?**先看你手上是什么工具**,对号入座走一条路就行。三条路最终遵循的是同一套公文规范,区别只在「怎么把规则喂给 AI」。
1010

11-
### 模式一 · 你用的是能装「skill」的工具(Codex / Claude Code)
11+
**先看你手上是什么工具**,对号入座走对应一条路。三条路遵循同一套公文规范,区别只在「怎么把规则喂给 AI」。完整操作步骤见 **[二、使用](#usage)**
1212

13-
装一次,以后直接对话即可。
14-
15-
- **Claude Code**:把本仓库复制成 `~/.claude/skills/official-document-drafting`,然后在对话里输入 `/official-document-drafting`,再说要写什么:
16-
17-
```text
18-
/official-document-drafting
19-
根据这些材料,起草一份关于开展节前安全检查的通知
20-
```
21-
22-
- **Codex 等兼容宿主**:把本仓库复制进 `~/.codex/skills/`,触发词改成 `$official-document-drafting`
23-
24-
👉 安装命令(含从 GitHub 一键安装、Windows 写法)见 **[一、安装](#install)**
25-
26-
### 模式二 · 你用网页版 AI 助手(DeepSeek 网页版、文心、Kimi 等,能自己联网搜)
27-
28-
**不用安装任何东西**,复制一段现成提示词粘进对话框即可。
29-
30-
1. 打开你要写的文种的提示词文件,全选复制:[通知](./dist/offline/default/doc-types/notice-%E9%80%9A%E7%9F%A5/prompt.md)[报告](./dist/offline/default/doc-types/report-%E6%8A%A5%E5%91%8A/prompt.md)[请示](./dist/offline/default/doc-types/request-%E8%AF%B7%E7%A4%BA/prompt.md)[纪要](./dist/offline/default/doc-types/minutes-%E7%BA%AA%E8%A6%81/prompt.md)(其余文种见 [全部提示词目录](./dist/offline/default/doc-types/))。
31-
2. 粘进 DeepSeek 网页版对话框,在后面补一句你的具体要求,例如:「请联网搜索『XX』的最新情况,据此起草。」
32-
3. AI 给出 Markdown 成稿;想要 Word 时,在一台装了 Python 的电脑上按 [五、Word 导出与版式](#word-export) 导出。
33-
34-
👉 更多说明见 **[二、使用 ·(二)网页版 AI 助手](#usage)**
35-
36-
### 模式三 · 你在内网,电脑不能上网(本地 WebUI / Qwen / AnythingLLM)
37-
38-
和模式二复制的是**同一个提示词文件**,唯一区别:不能联网,所以**素材要你自己准备好**,连同提示词一起喂给本地模型。
39-
40-
1. 同样从 [全部提示词目录](./dist/offline/default/doc-types/) 复制目标文种的 `prompt.md`
41-
2. 把你手里的素材(文件、要点)一并提供给本地模型——它不上网,只用你给的材料写,不会替你编造事实。
42-
3. 拿到成稿后同样可导出 Word。模型容易跑偏时,可先让它出提纲、确认结构后再扩写正文。
13+
| 你的工具 | 怎么用(一句话) | 详细步骤 |
14+
|---|---|---|
15+
| **能装 skill**(Codex / Claude Code) | 装一次,之后对话里触发 `/official-document-drafting` 直接说要写什么,无需复制提示词 | [一、安装](#install)[二 ·(一)](#usage) |
16+
| **网页版 AI**(DeepSeek 网页版 / 文心 / Kimi,能联网) | 不用安装,复制对应文种现成 `prompt.md` 粘进对话框,让它联网搜资料 | [二 ·(二)](#usage) |
17+
| **内网离线**(本地 WebUI / Qwen / AnythingLLM) | 同一批 `prompt.md`,但素材要你自己准备好一起喂;有 Python 还能用 `build.py` 按素材现拼 | [二 ·(三)](#usage) |
4318

44-
👉 详见 **[二、使用 ·(三)内网离线](#usage)**
19+
> **现成提示词直达**[报告](./dist/offline/default/doc-types/report-%E6%8A%A5%E5%91%8A/prompt.md)[通知](./dist/offline/default/doc-types/notice-%E9%80%9A%E7%9F%A5/prompt.md)[请示](./dist/offline/default/doc-types/request-%E8%AF%B7%E7%A4%BA/prompt.md)[纪要](./dist/offline/default/doc-types/minutes-%E7%BA%AA%E8%A6%81/prompt.md)[全部文种](./dist/offline/default/doc-types/));想先看完整效果就翻 [样例/](./样例)。成稿要 Word 时见 [五、Word 导出与版式](#word-export)
4520
4621
### 这个仓库里,哪些文件夹是给你用的?
4722

@@ -60,27 +35,6 @@
6035

6136
> **名字怎么区分****`样例/`** = 完整跑通的成品(任务 → 素材 → 提示词 → 成稿 → Word,给你看效果);**范文** = `prompts/.../examples.md` 里喂给 AI 的片段;**`skills/`** = 各项能力的路由说明。三者不是一回事,别混。
6237
63-
<a id="toc"></a>
64-
65-
## 目录
66-
67-
- [零、快速上手:先对号入座](#quickstart)
68-
- [一、安装](#install)
69-
- [二、使用](#usage)
70-
- [三、项目概览](#overview)
71-
- [四、当前能力](#capabilities)
72-
- [五、Word 导出与版式](#word-export)
73-
- [六、图片、附件与附录](#images-attachments-appendices)
74-
- [七、结构校验](#validation)
75-
- [八、规则体系](#rules)
76-
- [九、构建与目录说明](#build-and-maintain)
77-
- [十、字体与依赖](#fonts-and-deps)
78-
- [十一、合规与使用声明](#compliance)
79-
- [十二、设计原则](#principles)
80-
- [十三、License](#license)
81-
- [十四、公开参考来源](#references)
82-
- [十五、反馈与贡献](#feedback)
83-
8438
<a id="install"></a>
8539

8640
## 一、安装
@@ -425,13 +379,7 @@ python3 src/renderers/docx.py \
425379
- `src/adapters/skill/`:把 `prompts/` 主源适配成 Codex、agents、Claude Code 等在线 skill / agent 宿主可直接使用的产物
426380
- `src/adapters/offline/`:把 `prompts/` 主源适配成 WebUI、AnythingLLM、Qwen、Claude.ai 等提示词宿主可直接使用的离线或半离线提示词产物
427381

428-
进一步查看:
429-
430-
- [prompts/](./prompts):全部规则和 profile 的主源目录。
431-
- [src/adapters/](./src/adapters):不同宿主环境的适配层目录。
432-
- [dist/](./dist):正式构建产物目录。
433-
- [dist/offline/default/](./dist/offline/default/):默认 profile 的正式离线产物目录。
434-
- [assets/templates/](./assets/templates):按文种导出的兼容模板目录。
382+
完整的带注释目录结构见 [九 ·(三)目录结构](#build-and-maintain)
435383

436384
### (一)文种覆盖范围
437385

@@ -788,17 +736,6 @@ python3 -m pytest -q # 含 test_build_sync 同步守卫、references 一致性
788736

789737
### (三)目录结构(tree 视图)
790738

791-
如需直接跳到具体目录,可优先查看:
792-
793-
- [prompts/](./prompts):规则、profile 和文种主源目录。
794-
- [src/](./src):全部代码(适配层 + 脚本 + 渲染入口)。
795-
- [assets/](./assets):字体和模板等静态资源目录。
796-
- [docs/](./docs):面向读者的说明文档与历史实施计划。
797-
- [skills/](./skills):从本仓抽出的同源薄路由 skill(导出、质检、离线打包、构建、文种判定、部委动态、关键词跟踪)。
798-
- [tests/](./tests):构建同步、references 一致性、skill 路由防腐等测试。
799-
- [dist/](./dist):正式构建产物目录。
800-
- [样例/README.md](./样例/README.md):示例文稿和导出样稿索引。
801-
802739
第一层级精简为 8 个目录(`prompts/ src/ assets/ dist/ 样例/ docs/ skills/ tests/`)加少量根文件:
803740

804741
```text

0 commit comments

Comments
 (0)