mcpField
S
scientific-manuscript-writing

scientific-manuscript-writing

github.com/jaechang-hits文档处理38484 次安装6 天前更新
代码仓库

关于 scientific-manuscript-writing

这项参考技能面向生物医学、社会科学、工程和计算领域的科学论文规划与写作,汇集 IMRAD 结构、引用格式、图表设计和报告指南实践。

主要功能

  1. 01IMRAD 论文结构
  2. 02科学表达清晰度与准确性指导
  3. 03引用格式选择与核对
  4. 04图表设计原则
  5. 05报告指南建议
  6. 06适配期刊写作要求

适用场景

  1. 01规划原创研究论文各部分
  2. 02按目标期刊整理引用
  3. 03设计用于发表的图表
  4. 04依据研究报告指南检查论文

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/jaechang-hits/sciagent-skills --skill scientific-manuscript-writing

安装后在 Claude Code 中输入/scientific-manuscript-writing确认已加载。

详细介绍

科学论文写作

概述

科学论文写作是一门以严谨、清晰且可复现的方式传达研究发现的学科。这项知识涵盖论文准备的完整生命周期:从使用 IMRAD 格式规划和组织论文,到采用正确的引用格式并设计有效的图表,再到确保符合特定研究的报告指南。它适用于生物医学、社会科学、工程和计算等领域。

本条目整合了写作原则、论文结构、引用体系、图表设计和报告标准,构成一份统一的参考资料,帮助撰写可供发表的科学文档。

关键概念

写作原则:清晰、简洁、准确

科学写作的三大支柱决定了论文中的所有文本:

  • 清晰:使用准确、明确的语言。首次使用技术术语时应加以定义。确保段落内部及段落之间的逻辑连贯。在有助于理解时使用主动语态;在方法部分,如果动作比执行者更重要,则可以使用被动语态。
  • 简洁:用尽可能少的词表达观点。删去冗余短语(将“due to the fact that”改为“because”;将“in order to”改为“to”)。尽量使用较短的句子(平均 15-20 个词)。使用有力的动词,而非名词与动词的组合(用“analyze”,而不是“perform an analysis”)。
  • 准确:根据测量能力,以适当的精度报告准确数值。全文使用一致的术语。区分观察结果和解释。核实正文中的数字与表格和图表一致。

其他原则包括客观性(无偏地呈现结果,并承认相互矛盾的证据)、一致性(同一概念使用相同术语,符号规范统一)和逻辑组织(各章节之间有清晰的“主线”)。详细指南和示例请参阅 references/writing_principles_style.md。

IMRAD 结构

IMRAD(引言、方法、结果与讨论)是原创研究论文的标准组织结构,自 20 世纪 70 年代以来已被大多数科学学科采用。它反映了科学方法:

部分回答的问题主要时态典型篇幅
标题主题是什么?不适用10-15 个词
摘要完整总结混合100-250 个词
引言为什么开展这项研究?现在时/过去时4-5 段
方法如何开展研究?过去时2-4 页
结果发现了什么?过去时2-4 页
讨论这意味着什么?过去时/现在时3-5 页
结论核心要点现在时1-2 段

引言采用漏斗式结构:从宽泛背景开始,逐步聚焦文献综述,指出研究空白,并说明研究目标。方法部分必须提供足够的细节,以便他人复现。结果部分客观呈现发现,不加解释。讨论部分解释研究发现,与以往研究进行比较,承认局限性,并提出未来研究方向。

不同发表平台的差异:Nature/Science 使用经过调整的 IMRAD 结构,并将方法放在补充材料中。机器学习会议(NeurIPS/ICML)采用引言-方法-实验-结论结构,列出编号的贡献并开展消融研究。各章节的详细指南请参阅 references/manuscript_structure.md。

引用格式

五种主要引用格式适用于不同学科:

格式形式主要学科
AMA上标数字医学、健康科学
Vancouver方括号中的数字 [1]生物医学
APA作者-日期(Smith,2023)心理学、社会科学
Chicago注释-参考书目或作者-日期人文学科、部分科学领域
IEEE方括号中的数字 [1]工程学、计算机科学

所有格式通用的最佳实践:尽可能引用一手资料。纳入近期文献(活跃领域为近 5-10 年,机器学习为近 2-3 年)。在引言和讨论部分均衡分布引用。对照原始来源核实所有引用。自引比例保持在 20% 以下。务必查阅目标期刊的作者指南,确认所需格式。

完整的格式规范、期刊特定要求和 DOI 格式规则,请参阅 references/citation_guide.md。

图表设计原则

图和表是科学论文的支柱;许多读者会先查看图表,再阅读正文。

判断规则:这些信息能否用 1-2 句话表达?如果可以,只用文字。如果不可以,且需要精确数值,则使用表格。如果不可以,且模式或趋势最重要,则使用图。

核心设计原则:

  1. 自明性:每个展示项都必须能够独立理解,并配有完整说明,解释所有缩写、单位、样本量和统计标注
  2. 避免冗余:正文突出展示项中的关键发现,而不是重复所有数据
  3. 保持一致:所有展示项的格式、配色方案和术语保持统一
  4. 数量适宜:每 1,000 字稿件约配一个展示项
  5. 无障碍性:使用色盲友好型配色(蓝橙、viridis);确保设计在灰度下也能正常呈现

误差线规则:务必说明所示指标(数据离散程度用 SD,测量精度用 SEM,显著性评估用 95% CI)。通常优先使用 95% CI,因为不重叠的 CI 表示差异显著。

有关图表类型选择、表格格式、统计结果呈现和期刊特定要求,请参阅 references/figures_tables_guide.md。

决策框架

What type of scientific document are you writing?
|
+-- Original research article
|   |
|   +-- Clinical trial --> IMRAD + CONSORT reporting guideline
|   +-- Observational study --> IMRAD + STROBE reporting guideline
|   +-- Animal study --> IMRAD + ARRIVE reporting guideline
|   +-- Diagnostic accuracy --> IMRAD + STARD reporting guideline
|   +-- Prediction model --> IMRAD + TRIPOD reporting guideline
|   +-- ML/CS research --> Intro-Method-Experiments-Conclusion
|
+-- Review / synthesis
|   +-- Systematic review --> PRISMA reporting guideline
|   +-- Narrative review --> Thematic structure
|   +-- Meta-analysis --> PRISMA + forest plots
|
+-- Case report --> CARE guideline
|
+-- Study protocol --> SPIRIT guideline
|
+-- Quality improvement --> SQUIRE guideline
|
+-- Economic evaluation --> CHEERS guideline
|
+-- Professional report / white paper --> scientific_report.sty (see assets/)
出版渠道类型结构引用格式关键调整
Nature/Science改良 IMRAD,方法置于补充材料中上标数字语言通俗易懂、强调广泛意义、以故事为导向
医学期刊(NEJM、JAMA)严格遵循 IMRADVancouver/AMA结构化摘要、聚焦临床、遵循 CONSORT/STROBE
领域专刊标准 IMRAD因领域而异提供完整技术细节、使用领域术语
ML 会议(NeurIPS、ICML)引言-方法-实验-结论编号或作者-年份列出编号贡献、消融实验、伪代码
专业报告按章节组织不适用使用 scientific_report.sty 进行格式设置

最佳实践

  1. 最后撰写摘要:完成所有章节后,将核心信息提炼为 100-250 个词。纳入带有统计指标的定量结果。
  2. 先规划图表,再开始写作:将图表设计为数据故事的骨架。先写方法,再写描述图表的结果,然后写解读结果的讨论,最后写提出研究问题的引言。
  3. 每段只阐述一个观点:以主题句开篇,用支持性证据展开,最后过渡到下一个观点。每段以 3-7 句为宜。
  4. 合理定义缩写:在摘要和正文中首次使用时分别定义。仅缩写使用 3 次及以上的术语。每篇论文新增缩写不超过 3-4 个。DNA、RNA、PCR 等标准缩写无需定义。
  5. 正确使用动词时态:已完成的工作(方法、结果、既往研究)使用过去时。公认事实和个人解读使用现在时。与当前相关的近期进展使用现在完成时(“近期研究已经证明……”)。
  6. 完整报告统计数据:每项比较都应包括点估计、变异性指标(SD/SEM/CI)、样本量、检验统计量、确切的 p 值(而不只是“p < 0.05”),以及带有置信区间的效应量。
  7. 从一开始就遵循报告指南:在研究设计阶段确定适用的指南,而不是等到稿件完成后再确定。起草时使用清单,确保涵盖所有必要内容。
  8. 使写作风格契合投稿刊物:查阅目标期刊近期发表的 3-5 篇论文。调整句子长度、词汇难度、审慎措辞风格和各章节篇幅比例,以符合期刊要求。
  9. 核对引文与参考文献是否对应:每条文内引文都必须有对应的参考文献条目,反之亦然。投稿前核对作者姓名、年份、标题和 DOI。
  10. 兼顾无障碍性:使用适合色觉障碍读者的配色方案。确保图表在灰度模式下仍清晰可读。按最终印刷尺寸,字体至少为 8-10 pt。图表使用 PDF、EPS 等矢量格式。

常见问题

  1. 结论超出证据支持的范围:根据观察性数据声称因果关系,或将结论推广到研究人群之外。

    • 如何避免:使用恰当的审慎措辞(“提示”“相关”)。让结论的力度与研究设计相符。
  2. 术语不一致:用不同词语指代同一概念(在“用药”“药物”和“药品”之间切换)。

    • 如何避免:为每个概念选定一个术语,并在全文中保持一致。起草前先创建术语表。
  3. 动词时态混用不当:用现在时描述具体研究结果,或用过去时描述已确立的事实。

    • 如何避免:遵循各章节的时态规则。修改时检查各章节的时态是否一致。
  4. 方法细节不足,难以复现:遗漏样本量、软件版本、统计检验的依据或伦理审批信息。

    • 如何避免:使用相关报告指南的核对清单。请同事评估,仅凭方法部分能否复现这项研究。
  5. 数据呈现冗余:在正文中重复表格中的所有数值,或在图和表之间重复信息。

    • 如何避免:正文应突出并解读图表中的关键发现,而不是复述所有数值。每个数据点只以一种形式呈现。
  6. 误差线缺失或设计不当:完全省略误差线,或未说明误差线表示 SD、SEM 还是 CI。

    • 如何避免:所有定量图表都应包含误差线。每个图注都要说明误差线代表的指标(“误差线表示 95% CI”)。
  7. 缩写过多:定义过多缩写,或将仅使用一两次的术语缩写。

    • 如何避免:仅缩写使用 3 次及以上的术语。每篇论文新增的缩写不超过 3-4 个。标题中绝不使用缩写。
  8. 忽视期刊特定要求:投稿时引用格式错误、超出字数限制,或使用不正确的图表格式。

    • 如何避免:开始撰写稿件前先阅读作者指南。创建期刊要求核对清单,并在投稿前确认符合要求。

工作流

  1. 规划阶段

    • 确定目标期刊并查阅作者指南(字数限制、引用格式、图表规格)
    • 确定适用的报告指南(CONSORT、STROBE、PRISMA 等)
    • 下载报告核对清单,并查看需要提前规划的条目
    • 拟定论文结构(通常为 IMRAD,除非投稿期刊另有要求)
  2. 文献综述

    • 使用系统化的数据库检索式搜索相关既有研究
    • 使用文献管理工具整理参考文献(Zotero、Mendeley、EndNote)
    • 找出研究旨在填补的知识空白
    • 记录可用于引言和讨论部分的关键研究
  3. 构建提纲

    • 为各章节拟定提纲,以项目符号标注主要论点、关键引文、数据点和逻辑脉络
    • 将图表规划为核心数据叙事
    • 将报告核对清单中的条目对应到论文各章节
  4. 撰写(章节顺序:方法、结果、讨论、引言、摘要、标题)

    • 将各部分提纲扩展为连贯的段落
    • 方法:详细说明所做工作,确保足以复现
    • 结果:客观呈现发现,并引用图表
    • 讨论:解读发现、与文献比较并承认局限性
    • 引言:介绍背景、指出空白并陈述研究目标
    • 摘要:用 100-250 个词概述完整研究内容
    • 决策点:若面向特定投稿期刊撰写,请查阅该期刊专属的风格指南
  5. 图表定稿

    • 按最终尺寸和分辨率(300+ dpi)制作适合发表的图表
    • 撰写自解释的图注,列出所有缩写、单位、样本量和统计学标注
    • 按首次提及的顺序连续编号图表
    • 确认正文、图和表之间没有重复呈现数据
  6. 修订与质量控制

    • 检查逻辑是否连贯,以及论文全文的“主线”
    • 确认术语和符号的一致性
    • 逐项核对报告指南清单
    • 确认所有引文准确且格式规范
    • 校对语法、拼写和表达清晰度
    • 检查字数和页数是否符合期刊限制
  7. 准备投稿

    • 按照期刊要求排版(模板、引用格式、图表格式)
    • 准备补充材料
    • 填写并上传报告指南核对清单
    • 撰写附信,突出研究的重要性及其与期刊的契合度
    • 准备所需声明(经费、利益冲突、数据可用性、伦理审批)
    • 最后核查:每条文内引文都有对应的参考文献条目,反之亦然

打包资源

参考文件
文件内容原始来源
references/writing_principles_style.md清晰、简洁、准确的策略,动词时态规则,用词,段落结构,修订检查清单,以及针对不同投稿场合的写作风格摘编自 writing_principles.md(825 行)
references/manuscript_structure.md完整的 IMRAD 指南,逐节说明内容与常见错误,不同投稿场合的结构差异,以及机器学习会议论文结构摘编自 imrad_structure.md(659 行)
references/citation_guide.mdAMA、Vancouver、APA、Chicago、IEEE 格式规范,期刊特定风格,引用最佳实践,DOI 格式摘编自 citation_styles.md(721 行)
references/figures_tables_guide.md图表类型选择、表格格式、统计结果呈现、无障碍要求、期刊特定要求、投稿检查清单摘编自 figures_tables.md(807 行)
references/reporting_guidelines.mdCONSORT、STROBE、PRISMA、SPIRIT、STARD、TRIPOD、ARRIVE、CARE、SQUIRE、CHEERS 检查清单摘要及使用工作流摘编自 reporting_guidelines.md(749 行)

省略内容:professional_report_formatting.md(665 行)——LaTeX 专属格式细节已由 assets/ 目录中的 scientific_report.sty 模板及其配套文件 REPORT_FORMATTING_GUIDE.md 直接涵盖。关键概念(框环境、科学计数法命令)在下方的资源部分中有所说明。

资源文件
文件描述
assets/scientific_report.sty用于专业报告(非期刊论文)的 LaTeX 样式包。提供 Helvetica 字体、彩色框环境(keyfindings、methodology、limitations 等)、交替行表格,以及科学计数法命令(\pvalue、\effectsize、\CI、\meansd)。使用 XeLaTeX 或 LuaLaTeX 编译。
assets/scientific_report_template.tex完整的 LaTeX 模板,演示所有样式功能:标题页、执行摘要、含框环境的章节、统计表格、图表格式和附录。
assets/REPORT_FORMATTING_GUIDE.md样式包的快速参考指南:调色板(十六进制值)、框环境语法、科学计数法命令参考、表格和图表格式示例、编译说明。

延伸阅读

  • EQUATOR Network —— 健康研究报告指南的综合资料库
  • ICMJE Recommendations —— 生物医学期刊投稿论文的统一要求
  • APA Style Guide —— APA《出版手册》官方资源
  • Nature Masterclasses —— Nature 提供的科学写作课程
  • Academic Phrasebank —— 按功能分类的常用学术短语(曼彻斯特大学)
  • Strunk 和 White,《The Elements of Style》—— 清晰写作的经典指南
  • Lebrun,《Scientific Writing: A Reader and Writer's Guide》—— 面向科学作者的实用指南

相关技能

  • matplotlib-scientific-plotting —— 为论文创建适合发表的图表
  • seaborn-statistical-plots —— 自动计算 CI 和汇总结果的统计可视化
  • plotly-interactive-plots —— 用于补充材料的交互式图表
  • statsmodels-statistical-modeling —— 用于论文报告结果的统计模型
  • pymc-bayesian-modeling —— 用于报告的贝叶斯分析结果
  • peer-review-methodology —— 论文的结构化同行评审(与此条目互为补充)
  • latex-research-posters —— 使用 LaTeX 制作海报
  • scientific-slides —— 准备会议演示文稿
  • scientific-brainstorming —— 用于构思研究问题的创意方法

配套资源

  • assets/scientific_report.sty -- 用于撰写专业科学报告的 LaTeX 样式包
  • assets/scientific_report_template.tex -- 展示所有样式功能的完整报告模板
  • assets/REPORT_FORMATTING_GUIDE.md -- 盒式环境、调色板和科学记数法命令的速查卡

评论

支持 Markdown