Rewrite README in Chinese
This commit is contained in:
qyh15
parent
c5fe6a6800
commit
c3e16f1812
188
README.md
188
README.md
|
|
@ -1,108 +1,105 @@
|
||||||
# QQsci
|
# QQsci
|
||||||
|
|
||||||
QQsci is a Codex workflow skill for scientific manuscript projects. It acts as
|
QQsci 是一个面向科研论文项目的 Codex 工作流总控 skill。它不是单一写作工具，而是负责调度论文项目中的文献、写作、图表、投稿包检查、引用批注和返修相关流程。
|
||||||
the top-level orchestrator for materials-science writing, literature-grounded
|
|
||||||
revision, submission-package audit, Word DOI-only citation comments, and future
|
|
||||||
specialized modules such as QQwrite, QQfigure, and QQppt.
|
|
||||||
|
|
||||||
It is designed for workflows that combine:
|
当前重点面向材料科学论文，尤其适合处理：
|
||||||
|
|
||||||
- manuscript and Supporting Information `.docx` files
|
- `Manuscript.docx` 主稿
|
||||||
- main figures, SI figures, and TOC `.pptx` files
|
- `Supplementary Information.docx` 补充信息
|
||||||
- Zotero literature items and AI-generated Zotero child notes
|
- `Figures.pptx` 主图
|
||||||
- QQnote-generated literature summaries or comparison tables
|
- `Supplementary Information.pptx` 补充图
|
||||||
- target-journal positioning and reviewer-style pre-submission audit
|
- `Highlights.docx`
|
||||||
- AFM Word article template assets
|
- `CoverLetter.docx`
|
||||||
|
- `TOC.pptx`
|
||||||
|
- Zotero 文献和 QQnote 生成的 AI 文献笔记
|
||||||
|
- AFM 等材料期刊的投稿模板和整包质控
|
||||||
|
|
||||||
## Workflow Role
|
## 核心定位
|
||||||
|
|
||||||
QQsci is the research-writing workflow controller, not a single-purpose writing
|
QQsci 的定位是：
|
||||||
tool. It should decide which module to call, pass structured inputs between
|
|
||||||
modules, and perform final package-level quality control.
|
|
||||||
|
|
||||||
Planned module ecosystem:
|
```text
|
||||||
|
科研论文工作流总调度器
|
||||||
|
```
|
||||||
|
|
||||||
| Module | Role |
|
它负责判断当前任务应该交给哪个模块，如何传递输入输出，以及最后如何把所有结果合并为一个可投稿的论文包。
|
||||||
|---|---|
|
|
||||||
| QQnote | Zotero child-note summaries and paper comparison tables |
|
|
||||||
| QQwrite | Long-form manuscript drafting, section rewriting, and Word template use |
|
|
||||||
| QQfigure | Materials figures, mechanism diagrams, TOC graphics, and figure QA |
|
|
||||||
| QQppt | Group meeting, journal club, submission, and defense slides |
|
|
||||||
| nature-citation | High-quality DOI candidates and claim-reference support |
|
|
||||||
| nature-data | Data availability, source data, repository, and FAIR checks |
|
|
||||||
| nature-response | Reviewer-response and revision-letter workflows |
|
|
||||||
| academic-humanizer | Academic de-AI wording, style naturalization, and consistency checks |
|
|
||||||
|
|
||||||
QQsci's built-in modules remain the quality-control layer until specialized
|
## 当前已经具备的能力
|
||||||
QQ* modules are developed.
|
|
||||||
|
|
||||||
## Current Scope
|
QQsci 当前内置以下能力：
|
||||||
|
|
||||||
QQsci owns the manuscript-facing reasoning:
|
- 从主题、初稿、图注、SI 或 cover material 中提取关键词
|
||||||
|
- 根据文献笔记筛选强相关和弱相关论文
|
||||||
|
- 使用强相关论文对比检查创新性、机制证据、控制实验和 benchmark
|
||||||
|
- 检查主稿、SI、Figures、Highlights、Cover Letter、TOC 的整包一致性
|
||||||
|
- 检查图表逻辑、图注、单位、样品名、术语、拼写和格式问题
|
||||||
|
- 生成 Markdown 版 reviewer report
|
||||||
|
- 在 Word 主稿中添加原生批注，批注内容只包含 DOI，一行一个 DOI
|
||||||
|
- 管理 DeepSeek、Zotero、Obsidian、QQnote 和模板路径配置
|
||||||
|
- 保存 AFM Word 文章模板资产
|
||||||
|
|
||||||
- extract manuscript keywords from topic, draft, figures, SI, or cover material
|
QQsci 不直接插入 Zotero Word citation field。对于 Word 主稿，QQsci 只用 Word 原生批注标出 DOI，正式插入引用仍建议使用 Zotero Word 插件。
|
||||||
- classify strongly and weakly related papers
|
|
||||||
- compare the manuscript with strongly related papers
|
|
||||||
- audit missing experiments, controls, mechanisms, benchmarks, and statistics
|
|
||||||
- check figures, captions, SI consistency, formatting, spelling, and terminology
|
|
||||||
- produce Markdown reviewer reports
|
|
||||||
- add Word native citation comments containing DOI strings only
|
|
||||||
- route work to QQnote and future QQwrite/QQfigure/QQppt modules
|
|
||||||
- manage project-level DeepSeek, Zotero, Obsidian, and template configuration
|
|
||||||
|
|
||||||
QQsci does not directly insert Zotero Word fields. For Word manuscripts, citation
|
## QQnote 的角色
|
||||||
suggestions are added as native comments with one DOI per line.
|
|
||||||
|
|
||||||
## QQnote Relationship
|
QQnote 是 QQsci 的文献输入工具。
|
||||||
|
|
||||||
QQnote is used only as the literature-note input tool.
|
QQnote 负责：
|
||||||
|
|
||||||
QQnote may:
|
- 从 Zotero 条目生成 AI 文献笔记
|
||||||
|
- 将结果写入 Zotero child note
|
||||||
|
- 将选中文献总结成 Markdown 对比表
|
||||||
|
- 审计哪些 Zotero 条目缺少 AI 笔记
|
||||||
|
|
||||||
- generate or refresh Zotero child-note summaries
|
QQnote 不负责判断：
|
||||||
- summarize selected Zotero papers into Markdown comparison tables
|
|
||||||
|
|
||||||
QQsci then consumes those notes/tables and makes the manuscript decisions. QQnote
|
- 哪篇文献是强相关或弱相关
|
||||||
should not decide whether a paper is strongly related, weakly related, necessary
|
- 哪篇文献必须引用
|
||||||
for citation, or sufficient as reviewer evidence.
|
- 哪篇文献足以支撑 reviewer 级别的证据
|
||||||
|
- 文章创新性是否足够
|
||||||
|
- 投稿包是否达标
|
||||||
|
|
||||||
QQnote must remain usable by itself. When QQsci calls QQnote, QQsci can inject
|
这些判断都由 QQsci 完成。
|
||||||
its own DeepSeek and Zotero configuration through
|
|
||||||
`scripts/run_qqnote_with_qqsci_config.py`.
|
|
||||||
|
|
||||||
When QQsci calls QQnote, use:
|
当 QQsci 调用 QQnote 时，推荐使用：
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
py "$env:USERPROFILE\.codex\skills\qqsci\scripts\run_qqnote_with_qqsci_config.py" --script summarize_zotero_table -- --vault "C:\Users\qyh15\Documents\Obsidian Vault" --item-keys "SXAIQUJT X7GJZ627"
|
py "$env:USERPROFILE\.codex\skills\qqsci\scripts\run_qqnote_with_qqsci_config.py" --script summarize_zotero_table -- --vault "C:\Users\qyh15\Documents\Obsidian Vault" --item-keys "SXAIQUJT X7GJZ627"
|
||||||
```
|
```
|
||||||
|
|
||||||
## Configuration
|
这个 wrapper 会读取 QQsci 的本地配置，并把 DeepSeek/Zotero 配置注入为 QQnote 需要的环境变量。
|
||||||
|
|
||||||
Use `config/config.template.json` as the public template and create a private
|
## 配置方式
|
||||||
local file:
|
|
||||||
|
公开模板：
|
||||||
|
|
||||||
|
```text
|
||||||
|
config/config.template.json
|
||||||
|
```
|
||||||
|
|
||||||
|
真实本地配置：
|
||||||
|
|
||||||
```text
|
```text
|
||||||
config/config.local.json
|
config/config.local.json
|
||||||
```
|
```
|
||||||
|
|
||||||
Do not commit `config/config.local.json`.
|
不要提交 `config/config.local.json`，不要在聊天、README、日志或终端输出中泄露 API key。
|
||||||
|
|
||||||
QQsci is the top-level configuration owner for manuscript workflows. It maps its
|
QQsci 会把自己的配置映射到 QQnote 所需环境变量：
|
||||||
DeepSeek and Zotero settings into QQnote-compatible environment variables when
|
|
||||||
calling QQnote:
|
|
||||||
|
|
||||||
- `deepseek.api_key` -> `AWESOMEGPT_API_KEY`
|
| QQsci 配置 | QQnote 环境变量 |
|
||||||
- `deepseek.base_url` -> `AWESOMEGPT_BASE_URL`
|
|---|---|
|
||||||
- `deepseek.model` -> `AWESOMEGPT_MODEL`
|
| `deepseek.api_key` | `AWESOMEGPT_API_KEY` |
|
||||||
- `zotero.web_api_key` -> `ZOTERO_API_KEY`
|
| `deepseek.base_url` | `AWESOMEGPT_BASE_URL` |
|
||||||
- `zotero.user_id` -> `ZOTERO_USER_ID`
|
| `deepseek.model` | `AWESOMEGPT_MODEL` |
|
||||||
|
| `zotero.web_api_key` | `ZOTERO_API_KEY` |
|
||||||
|
| `zotero.user_id` | `ZOTERO_USER_ID` |
|
||||||
|
|
||||||
QQnote remains independently usable through its own environment variables, vault
|
QQnote 单独运行时仍然可以使用自己的环境变量、vault `.env` 或 AwesomeGPT/Zotero preferences。
|
||||||
`.env`, or AwesomeGPT/Zotero preferences.
|
|
||||||
|
|
||||||
## Submission Package Audit
|
## 投稿整包检查顺序
|
||||||
|
|
||||||
For a full submission package, QQsci checks files in this order:
|
对于完整投稿包，QQsci 默认按以下顺序检查：
|
||||||
|
|
||||||
1. `Manuscript.docx`
|
1. `Manuscript.docx`
|
||||||
2. `Figures.pptx`
|
2. `Figures.pptx`
|
||||||
|
|
@ -112,29 +109,60 @@ For a full submission package, QQsci checks files in this order:
|
||||||
6. `CoverLetter.docx`
|
6. `CoverLetter.docx`
|
||||||
7. `TOC.pptx`
|
7. `TOC.pptx`
|
||||||
|
|
||||||
The manuscript and main figures define the story. SI, highlights, cover letter,
|
主稿和主图决定故事线，SI、Highlights、Cover Letter 和 TOC 必须与它们保持一致。
|
||||||
and TOC must stay consistent with that story.
|
|
||||||
|
|
||||||
## Writing Templates
|
## 写作模板
|
||||||
|
|
||||||
Bundled template:
|
当前内置 AFM Word 模板：
|
||||||
|
|
||||||
```text
|
```text
|
||||||
assets/templates/afm/article-template.docx
|
assets/templates/afm/article-template.docx
|
||||||
```
|
```
|
||||||
|
|
||||||
This is stored as an asset. Do not edit it in place. Copy it to a manuscript
|
模板作为 asset 保存，不应直接原地修改。使用时应复制到具体论文输出路径。
|
||||||
output path before use.
|
|
||||||
|
|
||||||
QQsci can keep journal templates and evidence/audit logic. A future QQwrite
|
未来 QQwrite 可以复用这些模板，用于长文写作、模板化初稿和 Word 格式整理。
|
||||||
skill can reuse these templates for long-form manuscript drafting and formatting.
|
|
||||||
|
|
||||||
## Installed Location
|
## 未来模块规划
|
||||||
|
|
||||||
For Codex discovery, install under:
|
QQsci 会逐步发展成调度多个专业 skill 的工作流中心：
|
||||||
|
|
||||||
|
| 模块 | 规划职责 |
|
||||||
|
|---|---|
|
||||||
|
| QQnote | 文献笔记、Zotero child notes、文献对比表 |
|
||||||
|
| QQwrite | 正文写作、章节重写、Word 模板化成稿 |
|
||||||
|
| QQfigure | 材料图表、机制图、TOC、图像质控 |
|
||||||
|
| QQppt | 组会、论文汇报、投稿展示 PPT |
|
||||||
|
| academic-humanizer | 学术语言去 AI 味、自然化和风格统一 |
|
||||||
|
|
||||||
|
在这些模块成熟之前，QQsci 内置的质控模块继续承担论文审稿、证据链检查和整包一致性检查。
|
||||||
|
|
||||||
|
## 安装位置
|
||||||
|
|
||||||
|
Codex 识别路径：
|
||||||
|
|
||||||
```text
|
```text
|
||||||
C:\Users\qyh15\.codex\skills\qqsci
|
C:\Users\qyh15\.codex\skills\qqsci
|
||||||
```
|
```
|
||||||
|
|
||||||
The source repository is maintained separately and can be pushed to Gitea.
|
源仓库可推送到 Gitea：
|
||||||
|
|
||||||
|
```text
|
||||||
|
git@git.qyhhh.top:Skills/QQsci-skill.git
|
||||||
|
```
|
||||||
|
|
||||||
|
## 依赖和协作 skill
|
||||||
|
|
||||||
|
QQsci 当前或未来会依赖/协作以下 skill：
|
||||||
|
|
||||||
|
- `QQnote-skill`：Zotero + DeepSeek 文献笔记和文献对比表输入
|
||||||
|
- `nature-citation`：高质量 DOI 候选和 claim-reference 支撑
|
||||||
|
- `nature-data`：Data availability、source data、FAIR 和数据仓库检查
|
||||||
|
- `nature-response`：审稿意见回复和返修信
|
||||||
|
- `nature-figure`：投稿级科学图表生成和质量检查
|
||||||
|
- `nature-paper2ppt`：论文到汇报 PPT
|
||||||
|
- `nature-writing` / `nature-polishing`：Nature 风格写作结构和语言策略参考
|
||||||
|
- `QQwrite`：未来用于长文写作和 Word 模板化成稿
|
||||||
|
- `QQfigure`：未来用于材料图表、TOC 和机制图工作流
|
||||||
|
- `QQppt`：未来用于组会、论文汇报和投稿展示
|
||||||
|
- `academic-humanizer`：未来用于学术文本去 AI 味和风格自然化
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue