mcpField
D
documenting-with-sources

documenting-with-sources

github.com/mathbullet文档处理174139 次安装2 周前更新
代码仓库

关于 documenting-with-sources

为引用外部事实的 Markdown 文档制定通用写作规范,涵盖引用与引文格式,并禁止无依据的陈述和臆造解读。

主要功能

  1. 01要求事实性陈述附带引用
  2. 02统一文内引用与来源列表格式
  3. 03区分引文和作者行文
  4. 04非中文引文须附带译文
  5. 05禁止臆造关联与解读

适用场景

  1. 01为研究报告制定引用规范
  2. 02撰写有来源支撑的论文解读
  3. 03检查文档中的无依据陈述

安装

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

$npx skills add https://github.com/mathbullet/skills --skill documenting-with-sources

安装后在 Claude Code 中输入/documenting-with-sources确认已加载。

详细介绍

使用来源进行文档写作

编写引用外部来源的 Markdown 文档时常用的约定。适用于所有呈现取自其他来源的事实的交付内容,例如调查报告、论文解读等。

为每项事实性陈述添加引用

交付内容中的每项事实性陈述都必须附带引用。没有引用的陈述无法核实,作为有据可查的发现毫无价值。如果某项陈述无法关联到来源,请明确标注(例如“引用尚未确认”)。不要悄悄加入未经引用的陈述。

引用格式

  • 文内引用格式为 [标签(YYYY/MM),位置]。如何填写 标签 栏(出版物名称、作者简称、对于正在评审的论文仅写职位等),由调用此技能的技能决定。
  • 不要使用 [1] 或 [2] 等纯数字引用。仅用数字会迫使读者在正文和来源列表之间来回查找,降低可读性。
  • 关于引文块本身的格式(代码块围栏、原文与译文的配对方式、来源引用的位置、反面示例),请遵循 writing-quotation 技能。起草前请先阅读 writing-quotation。

引文与行文

  • 在视觉和结构上,将引文与行文(作者自己的总结或解读)清楚地区分开来。即使没有直接引用,也要确保写法不会让来源中的主张与作者的解读混为一谈。
  • 引用以作者工作语言之外的语言撰写的来源时,请在同一个代码块中附上译文和原文(参见 writing-quotation)。

不要捏造关联或解读

不要写入来源本身未包含的解读、猜测或关联。

  • 不要捏造来源中没有提及的关联,例如“这与 X 有关”“这可应用于 Y”或“这表明 Z”。
  • 不要将对话上下文或调用项目中的背景信息带入文档正文。对来源的描述必须仅限于来源本身的内容。
  • 正确示例:“主要批评:即使翻转标签,准确率也不总是下降;而文本梯度在数学上不同于经典梯度下降”(陈述来源实际表达的内容)。
  • 错误示例:“与 AI 写作改进的关联:基于反馈的改进在数学上不同于梯度下降……”(来源并未表达这一点;这种关联是根据对话上下文捏造的)。

来源列表格式

文档末尾的来源列表使用以下格式:

[标签, YYYY/MM] 作者。“标题。”出版物。URL

不要使用 - [n] 列表格式。

评论

支持 Markdown