Skip to content

Latest commit

 

History

History
151 lines (108 loc) · 4.94 KB

File metadata and controls

151 lines (108 loc) · 4.94 KB

CoPaper GUI 写作规则指南

本文档用于指导用户和 AI Agent 使用 CoPaper GUI 进行论文写作。

项目概述

CoPaper GUI 是一个基于树状结构的论文写作辅助工具,采用自顶向下的方式组织论文结构。论文以 Markdown 文件形式存储,通过标题层级组织结构,每个节点可包含描述、主题句、支撑句和图片等内容。

项目文件夹概述

  • .github/skills/ - 包含所有技能的定义文件
  • template/ - 模板文件夹,包含不同类型的论文模板
  • writingrules.md - 写作规则指南
  • README.md - 项目说明文档
  • fig/ - 图片文件夹

Markdown 文件结构

标题层级规则

层级 Markdown 语法 用途 是否可修改
1级 # 论文总标题 可编辑
2-5级 ## ~ ##### 组织论文结构框架 不可修改
6级 ###### 具体段落内容 可撰写正文

重要原则

  • 1-5 级标题仅用于组织论文结构,不直接撰写正文内容
  • 6 级标题代表一个具体段落,标题是主题句,正文是支撑句

节点元数据

每个标题节点下方可包含以下 HTML 注释形式的元数据:

## 节点标题
<!-- description: 这里是节点的描述内容,用于指导如何撰写该部分 -->

元数据字段说明

字段 类型 默认值 含义
description string "" 节点描述,用于指导该部分应如何撰写

示例

## 问题定义
<!-- description: 明确界定研究所要解决的问题及其背景。需要回答:问题是什么?为什么值得研究?有哪些实际应用场景? -->

写作规则

基本原则

  1. 保持结构完整:不要修改 2-5 级标题,它们定义了论文的整体框架
  2. 遵循描述指导:每个节点的 description 字段提供了该部分的写作指导,请仔细阅读并遵循
  3. 段落写作:6 级标题代表一个段落,标题是主题句,正文是支撑句
  4. 字数限制
    • 主题句:最多 50 字
    • 支撑句:最多 500 字

内容撰写规范

主题句(Topic Sentence)

  • 作用:概括段落核心观点,作为段落的"标题"
  • 要求:简洁明了,一般为一句话
  • 限制:不超过 50 字
  • 示例
    • ✅ "传统入侵检测系统对 APT 攻击的检测率不足 30%"
    • ❌ "我们发现传统的入侵检测系统在检测高级持续性威胁方面存在一些问题,检测率比较低"(过于冗长)

支撑句(Supporting Sentences)

  • 作用:展开论述主题句的观点
  • 内容:可包含具体例子、数据、论证、引用
  • 格式
    • 支持 LaTeX 公式:
      • 行内公式:$E=mc^2$ → 显示为 $E=mc^2$
      • 块级公式:$$\int_0^1 x^2 dx$$ → 独立成行显示
  • 限制:不超过 500 字
  • 示例
    根据 Mandiant 2023 年报告,APT 攻击平均潜伏期为 146 天,传统 IDS 的检测率仅为 28%。
    主要原因在于:(1)孤立检测忽略攻击阶段关联;(2)签名匹配无法识别零日攻击;(3)误报率
    高达 90%,真实告警被淹没。
    

图片

  • 格式:JPG、PNG、GIF
  • 大小:最大 5MB
  • 用途:展示架构图、流程图、实验结果、对比图表等
  • 建议:图片应配有文字说明,解释图片的核心信息

子节点扩展

当节点标题以数字结尾时(如"影响场景1"、"技术挑战1"),表示该节点可以复制扩展:

  • 扩展方式:完整复制该节点及其所有子节点的结构
  • 命名规则:递增数字编号(如"影响场景1" → "影响场景2")
  • 注意事项
    • 必须完整复制整个子树结构,包括所有元数据
    • 不要破坏原有的层级关系
    • 新节点的元数据应与原节点保持一致

示例

<!-- 原节点 -->
#### 影响场景1
<!-- description: 描述问题在某个具体场景中的关键作用 -->

<!-- 扩展后的新节点 -->
#### 影响场景2
<!-- description: 描述问题在某个具体场景中的关键作用 -->

内容段落添加

内容段落必须遵循以下规则:

  • 段落形式:内容段落必须以 6 级标题(######) 形式添加
  • 标题作用:6 级标题的文本即为该段落的主题句
  • 正文内容:支撑句写入节点的 content 字段

示例

## 问题定义
<!-- description: 明确界定研究所要解决的问题 -->

<!-- 以下是添加的内容段落(6级标题) -->
###### 传统入侵检测系统对APT攻击检测率不足30%
<!-- description: 具体阐述检测率低的原因和数据支撑 -->
(支撑句内容写入 content 字段)

错误示例

<!-- ❌ 错误:使用非6级标题作为内容段落 -->
## 问题定义
### 问题描述
(不允许,应使用6级标题 ######)