Skip to content

sakukae/write-lab-report

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 

Repository files navigation

write-lab-report 使用说明

write-lab-report 用于生成中文课程实验报告。它会按实验模板创建实验文件夹、源码文件夹、必要截图文件夹,并把报告内容写入模板对应区域。

调用方式

在 Codex 中直接说:

使用 $write-lab-report 帮我完成实验报告。
实验名称:……
实验目的:……

必填信息

  • 实验名称
  • 实验目的

选填信息

  • 实验编号,例如“实验一”
  • 姓名、学号、班级、课程名、教师名
  • 实验内容、实验要求
  • 老师上课步骤或实验过程
  • 指定环境版本
  • 已有源码、运行结果、截图
  • 图片生图提示词要求
  • 自定义 .doc/.docx 模板
  • 是否不需要源码
  • 是否不需要路径
  • 是否不用图片

模板规则

  • 当前对话中上传了新的 .doc/.docx 模板时,优先使用用户本次上传的模板。
  • 当前对话中没有上传或指定模板时,按照内置默认模板 assets/default-lab-report-template.doc 的样式生成实验报告。
  • 填写报告时不得修改模板原本字体样式,包括字体、字号、颜色、加粗、斜体、下划线、行距、对齐方式和列表缩进。
  • 新增内容必须继承对应框、表格单元格或相邻段落的原有样式。
  • 原模板中已有下划线的位置不得删线,必须在下划线上填写文字,模板首页的填空区域也按此规则处理。
  • 模板中原本已有的固定文本内容不要修改,例如“适用于软件类课程”等说明文字,除非用户明确要求修改。
  • 如果用户上传的是包含多个实验的模板,只填写当前实验对应的那个表格或区域,其余实验内容一律不修改。

默认行为

  • 新建 实验x 文件夹,例如 实验一
  • 在其中创建 源码 文件夹
  • 网页截图或运行截图会保存到 图片 文件夹
  • 报告直接保存在新建实验文件夹中
  • 用户未提供模板时,使用 assets/default-lab-report-template.doc 的结构和样式
  • 所有源码和文本文件使用 UTF-8 编码
  • “实验过程及分析”默认不超过六步,并且每一步先写步骤与分析,再贴 1-2 张图
  • “实验过程及分析”中的步骤、分析、源码位置等文本段落必须靠左对齐
  • 实验报告中不得出现用户项目绝对路径;源码位置统一写相对于 源码 文件夹的路径,例如 src/Main.java
  • “实验体会”约 150 字

图片提示词模式

用户可以明确说明“不需要源码不需要路径,只要图片生图提示词”。此时 skill 不写源码位置、文件名或路径,而是按实验步骤给出每步应产出的配图提示词。

风格规则:

  • Java 相关实验:IntelliJ IDEA 风格界面。
  • 虚拟机、Linux、SSH、网络配置、远程终端等操作:MobaXterm 风格界面。
  • 前端、C 语言、Python 和一般脚本实验:VSCode 风格界面。
  • 混合实验按每个步骤的主要工具选择风格;无法判断时默认 VSCode。

示例

使用 $write-lab-report 完成实验报告。
实验名称:Java 数据库连接实验
实验目的:掌握 JDBC 连接 MySQL、执行查询并展示结果的基本方法。
老师步骤:
1. 配置 JDK 和 MySQL
2. 创建数据库和测试表
3. 编写 JDBC 连接代码
4. 运行并分析查询结果

如果只想写报告,不需要真实源码:

使用 $write-lab-report 写实验报告。
实验名称:Web 表单验证实验
实验目的:掌握 HTML 表单、JavaScript 校验和页面交互。
不需要源码,不用图片。

只要图片提示词:

使用 $write-lab-report 写实验报告。
实验名称:Java 文件读写实验
实验目的:掌握 Java 文件输入输出流的基本使用。
不需要源码不需要路径,给我每个实验步骤对应的图片生图提示词。

About

SGU 实验报告skill

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors