Skip to content

About

Evidence-grounded manuscript writing, journal transfer, Word fidelity, and technical resubmission workflows for Codex.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

5 Commits

Folders and files

Repository files navigation

paperwriter

用于科研论文写作、期刊风格学习、转刊与投稿包检查的 Codex skill。

从目标期刊的真实文章学习论证结构,再依据作者的研究证据组织稿件。参考文章用于学习写作,实验事实来自作者的项目材料;二者分开记录。

本 README 分两部分:Part A「使用者」 面向需要用它写论文的作者;Part B「开发者」 面向想了解结构、修改或验证本仓库的人。可只读 Part A。


Part A · 使用者

适用任务

  • 初始化论文工作目录,整理期刊材料、研究证据与写作计划。
  • 从目标期刊范文学习段落任务、信息顺序和证据组织。
  • 构建论文主线、起草和修改英文稿件,并单独提供中文编辑说明。
  • 基于作者最新 Word 稿进行转刊,保留其内容、公式和格式。
  • 核对主稿、Supporting Information、图表、Cover Letter 等文件的一致性。
  • 根据编辑的技术退回意见检查文章类型、实际字数与独立图表附件。

不用于替代原始实验核验,也不承诺投稿接收、科学正确性或查重结果。单句润色通常无需启用完整工作流。

安装

任选一种方式,把本仓库放到 Codex 的 skills 目录,并命名为 paperwriter。

方式一:让 Codex 帮你装(推荐给不熟悉命令行的用户)

在 Codex 中直接说:

请把 https://github.com/Hongcheng-LI/paperwriter
安装为我的 Codex skill,目录名用 paperwriter。

Codex 会自行把仓库取回并放到 ~/.codex/skills/paperwriter(使用自定义 CODEX_HOME 时放在其下的 skills)。若本机缺少 git,Codex 可改用下载解压的方式完成。

方式二:命令行手动安装

git clone https://github.com/Hongcheng-LI/paperwriter.git "$env:USERPROFILE\.codex\skills\paperwriter"

使用自定义 CODEX_HOME 的用户,把路径换成 $env:CODEX_HOME\skills\paperwriter。已有同名安装时,先保留本地定制内容,再同步更新,不直接覆盖。

快速开始

1. 初始化论文工作目录。 在 Codex 中打开你的论文项目文件夹,输入:

使用 $paperwriter,为当前论文项目初始化工作目录。
请说明需要准备哪些材料,以及应该存放在哪里。

2. 学习目标期刊。 把目标期刊参考论文放到 01_inputs/01_target_journal/reference_articles,输入:

使用 $paperwriter,学习我提供的目标期刊论文。
请分析它们的写作结构、论证逻辑和结果组织方式,并结合我的研究内容,
提出适合本项目的论文写作框架。不要从参考论文中编造我的实验结果。

我会先给出推荐的叙事架构及其依据,并说明材料范围与提取局限,交你确认后再进入下一步。

3. 建立研究证据与主线。 提供真实研究结果、方法、数据、图表与现有草稿。先明确主要科学问题、核心证据与结论边界,再制定各章节写作蓝图;重要的范围与核心结论会先请你确认。

4. 起草与修改。 按已确认的主线分节撰写(语言可与作者约定,默认英文稿 + 中文段落级写作说明)。新项目默认以 05_drafts/merged_manuscript/manuscript.docx 作为唯一正式工作主稿。

5. 投稿前检查。 核对主稿、Supporting Information、图表与 Cover Letter 的数据、编号、引用及格式一致性。本地文件准备完成不等于正式提交:需作者确认科学内容后才整理投稿包,且不会自动外发提交。

转刊(journal transfer)与技术退回(字数、图表独立上传等)见 references/technical-resubmission.md 和 references/official-guidance-and-docx.md。

使用示例

  • 初始化工作目录:使用 $paperwriter,为这个论文项目初始化工作目录。
  • 先学期刊再定主线:使用 $paperwriter,先学习我提供的目标期刊文章,再结合我的研究结果提出论文主线和章节安排。
  • 处理技术退回:使用 $paperwriter,依据指定文件夹中的最新投稿文件,处理编辑提出的字数统计和图表独立上传要求。

工作原则

原始数据只读;优先保留作者最新版本;重要结论可追溯。区分期刊要求、范文习惯、研究事实与编辑判断。对未知参数保留核对事项,不从范文补造方法。

转刊时分别检查数据、正文信息和字符格式。技术重投时先统计实际字数,再判断是否需要删减,按适用要求拆分图表并校准主稿与 SI 引用。这里没有固定某个期刊的字数上限或通用的图表上传方式。


Part B · 开发者

仅在需要了解内部结构、修改或验证本仓库时阅读。

文件结构

  • SKILL.md:入口、适用边界和工作流。
  • references/:写作、证据、方法、Word 保真、投稿包及技术重投指引。
  • scripts/project_tools.py:项目初始化、材料清单与占位符检查工具。
  • scripts/test_project_tools.py:隔离临时目录中的功能测试。
  • assets/:通用目录结构和证据记录模板。

本仓库不包含作者论文、实验记录、谱图、文献全文或访问凭据。

验证

修改 scripts/ 下的工具后,可在仓库根目录运行以下测试确认行为未变:

python -m unittest discover -s scripts -p "test_*.py" -v

这些测试覆盖脚本的以下行为:初始化(幂等、保留用户文件、冲突预检)、安全路径(拒绝路径逃逸与符号链接重定向)、材料清单(revision 与 scope)、占位符检查。它们只验证脚本行为,不验证论文写作质量,也不等同于科学或格式审查通过。

About

Evidence-grounded manuscript writing, journal transfer, Word fidelity, and technical resubmission workflows for Codex.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages