Skip to content

handsomeZR-netizen/dachuang-report

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dachuang Report

Category Status

AI-assisted writing skill for engineering undergraduate innovation project final reports and structured defense materials.

Project Snapshot

  • Category: AI-assisted workflow tooling
  • Stack: academic-writing, codex-skill, innovation-training, report-writing, student-projects
  • Status: Public portfolio artifact

What This Demonstrates

  • Presents the project with a clear purpose, technology stack, and review path.
  • Shows applied AI workflow design in a concrete product or learning scenario.
  • Keeps implementation details and usage notes close to the code for easier reuse.

Quick Start

Start from README.md

Original Documentation

GitHub stars GitHub forks License GitHub issues PRs Welcome

Claude Code Ready Codex CLI Ready MCP Server 大创项目 Author


📘 一款专为工科大学生创新创业训练计划(大创)项目结题报告打造的AI辅助写作优化工具
覆盖软件系统、硬件设计、算法研究、智能系统、机械结构、物联网、嵌入式等全部工科方向

🚀 核心功能⚡ 快速开始📖 使用指南💡 核心技术🎯 适用方向❤️ 致谢


🔥 核心功能

✨ 八大写作优化原则

原则 描述
原则一 叙事主体转移——从「项目/系统」到「我们」,让报告呈现研究者的判断过程
原则二 技术选择必须说「为什么不是别的」,每个决策都有对比依据
原则三 段落推进——因果链而非清单,让叙述有逻辑有深度
原则四 工科实验验证——不只是报告数字,包含实验设计和对比基线选择理由
原则五 节末总结句——向前引导或直接删除,避免无信息量套话
原则六 实施过程必须有「困难—决策—影响」叙事,展现研究过程
原则七 创新特色必须说「已有工作做不到什么」,突出项目独特价值
原则八 第八章必须有「诚实的叙事视角」,客观说明局限与未来方向

🎯 智能诊断系统

  • 主语扫描:自动检测「项目」「系统」「本文」作主语的频率
  • 连接词密度检测:识别过度使用的连接词并提供替换建议
  • 技术选择检查:验证每个技术选型是否有「而非…」或「原因在于…」支撑
  • 章节详略比对:对照理想章节权重,发现详略失衡问题
  • 实验描述评估:检查验证章节是否包含完整实验设计依据

📊 理想章节权重参考

章节 建议篇幅 核心任务
摘要 ≤350字 问题+核心方法+量化结果+阶段定位
第一章 2-3页 建立问题张力,说清现有工具的缺口
第二章 1-2页 交代起点和遗留问题(常被写多)
第三章 3-4页 技术路线+架构设计动机
第四章 6-10页 每节都有「为什么这样做」
第五章 3-4页 困难—决策叙事,不是时间线
第六章 3-5页 量化结果+成果间逻辑关系
第七章 3-4页 区分于已有工作,不重复第四章(常被写少)
第八章 1-2页 诚实叙事,解释不足为什么存在

⚡ 快速开始

环境要求

  • Claude CodeCodex CLI 已安装并配置完成
  • Node.js v18.0.0 或更高版本(用于MCP服务器)
  • Git 用于版本控制

Note: 本项目同时支持 Claude Code 和 Codex CLI。Codex CLI 是 OpenAI 推出的命令行工具,可通过 /codex 命令直接调用本skill。

安装步骤

Claude Code 安装

# 1. 克隆本仓库
git clone https://github.com/hdu-sucks/wiki.git
cd wiki

# 2. 复制skill到项目的 .claude/skills 目录
mkdir -p .claude/skills
cp -r dachuang-report/ .claude/skills/

# 3. 配置 MCP 服务器(如需GitHub集成)
# 编辑 .claude/settings.json 添加 github-mcp 配置

Codex CLI 安装

# 1. 克隆本仓库
git clone https://github.com/hdu-sucks/wiki.git
cd wiki

# 2. Codex CLI 使用项目内的 .codex/skills 目录
mkdir -p .codex/skills
cp -r dachuang-report/ .codex/skills/

# 3. 在 Codex CLI 中直接调用
# /dachuang-report

基本使用

Claude Code 中使用

# 在Claude Code中调用skill
/dachuang-report

# 或者在对话中直接说明需求
"我需要优化我的大创结题报告,方向是嵌入式系统"

Codex CLI 中使用

# 在Codex CLI中直接调用skill
/codex dachuang-report

# 或者在对话中说明需求
"优化我的大创结题报告,方向是软件系统类"

支持的工具

工具 Claude Code Codex CLI 说明
/dachuang-report 主skill命令
Skill自动触发 当用户提到大创报告、结题报告等关键词时自动激活
GitHub MCP 用于创建Issue、PR等GitHub操作

📖 使用指南

Step 0:确认工程方向

使用本工具时,首先判断报告属于哪类工程方向:

方向类型 典型章节关键词 特有写作问题
软件系统类 架构设计、前后端、数据库、API、部署 架构描述像文档注释,缺设计决策理由
算法/AI类 模型选择、训练、推理、精度、损失函数 只报告指标,不解释为什么选这个方法
硬件/嵌入式类 传感器、MCU、PCB、驱动、功耗、时序 器件选型无理由,调试过程被略去
智能系统类 感知、决策、控制、状态机、闭环 各模块描述割裂,缺乏数据流叙述
机械/结构类 建模、仿真、有限元、强度、加工工艺 仿真参数来源不说明,与理论推导脱节
物联网类 通信协议、边云协同、功耗、时延 协议选型无对比,系统集成过程缺失

Step 1:五步快速诊断

在开始修改之前,进行以下五步诊断:

  1. 主语扫描 — 统计「项目」「系统」「本文」作主语的频率(超过40%需优先处理)
  2. 连接词密度 — 检测每页「基于」「围绕」「在此基础上」「由此」出现次数
  3. 技术选择检查 — 找出所有「采用」「选择」「使用」「引入」,检查是否有理由支撑
  4. 章节详略比对 — 对照理想章节权重,特别检查第二章是否超过2页
  5. 实验/验证描述 — 检查是否只有结论数字,没有实验设计依据

改写示例

案例一:算法选型

❌ 低质量写法

项目采用YOLO v8进行目标检测。

✅ 高质量写法

我们选择YOLO v8而非传统特征提取方法,原因在于需要在精度和推理速度之间取得平衡,在COCO数据集上YOLO v8的mAP@0.5达到81.3%,同时帧率可达120fps,完全满足实时性需求。

案例二:硬件平台选型

❌ 低质量写法

使用STM32F4作为主控。

✅ 高质量写法

选择STM32F4而非ESP32:控制周期为1ms,ESP32的FreeRTOS调度抖动在高负载下可达3-5ms,不满足实时性要求。STM32F4的HAL库中断响应时间<1μs,可靠保证控制周期。

案例三:系统架构描述

❌ 低质量写法

系统由前端层、业务逻辑层和数据层组成。前端层负责用户界面,业务逻辑层负责数据处理,数据层负责存储。

✅ 高质量写法

系统的三层划分是围绕「一次用户请求的完整数据流」来设计的。前端只负责展示和输入校验,不包含业务判断——这样做是为了让前端可以被不同终端复用而不修改逻辑;业务层完成推理和规则过滤,是整个系统的核心处理单元;结果写入数据层,与业务逻辑解耦,以便未来替换存储方案不影响上层。


💡 核心技术

叙事主体转移技术

将主语从「项目/系统」转移到「我们」,让报告具有研究者视角:

低质量:项目采用YOLO v8进行目标检测
高质量:我们选择YOLO v8而非传统特征提取方法

低质量:系统将传感器数据送入卡尔曼滤波器
高质量:考虑到传感器噪声特性,我们引入卡尔曼滤波器

低质量:本文设计了三层架构
高质量:我们把系统划分为三层,而没有选择微服务架构

技术选择对比框架

每个技术选型必须包含「而非…」或「原因在于…」:

场景 触发词 必须跟
算法选型 采用/选择 而非…,原因在于…
硬件平台 使用/采用 而非…,原因在于…
通信协议 选择 而非…,原因是…
数据库 使用 而非…,原因在于…

困难—决策—影响叙事模板

每个重要工程决策需包含三要素:

[困难/约束]  具体遇到了什么现实限制(要有具体数字)
[决策]       基于约束,选择了什么,放弃了什么
[后续影响]   带来了什么效果,是否引入新问题,如何应对

🎯 适用方向

本工具专为以下工科方向的大创项目结题报告优化设计:

方向 说明
🖥️ 软件系统类 Web/App开发、数据平台、分布式系统等
🤖 算法/AI类 深度学习、计算机视觉、NLP、推荐系统等
🔧 硬件/嵌入式类 MCU、传感器、驱动开发、PCB设计等
🎛️ 智能系统类 机器人、自动驾驶、工业控制等
⚙️ 机械/结构类 有限元分析、优化设计、制造工艺等
📡 物联网类 通信协议、边云协同、传感器网络等

🛠️ 技术架构

dachuang-report/
├── dachuang-report/                  # Skill主目录(即可直接复制使用)
│   ├── SKILL.md                      # 主skill文件(Claude Code格式)
│   ├── .codex-plugin/                # Codex CLI插件配置
│   │   └── plugin.json
│   └── references/
│       ├── chapter-guide.md          # 各章节详细改写示例
│       ├── sentence-patterns.md      # 句式模板库
│       └── domain-examples.md        # 领域专用示例
├── .claude/                          # Claude Code配置
│   ├── settings.json                 # Claude Code配置
│   └── skills/
│       └── dachuang-report/          # Skill安装目录
├── .codex/                           # Codex CLI配置(可选)
│   └── skills/
│       └── dachuang-report/          # Skill安装目录
├── README.md
└── LICENSE

部署说明:

  • Claude Code:将 dachuang-report/ 复制到项目的 .claude/skills/ 目录
  • Codex CLI:将 dachuang-report/ 复制到项目的 .codex/skills/ 目录
  • 两个平台的skills内容相同,可共用同一套文件

📝 摘要四段结构模板

第一段(1-2句):一句话定位
  → 研究对象是什么、要解决什么具体问题
  → 关键词:「针对…问题」「区别于…」「聚焦于…」

第二段(2-3句):方法核心
  → 选了什么路径、为什么不是别的、关键机制是什么
  → 关键词:「我们没有…而是…」「核心机制在于…」

第三段(2-3句):量化成果(必须出现至少两个数字+对比基线)
  → 关键词:「与对比方法相比…」「在XX条件下达到…」

第四段(1句):阶段定位
  → 关键词:「当前更适合定位为…原型」「后续仍需在…场景下验证」

🔧 配置说明

Claude Code MCP配置

如需启用GitHub MCP服务器,请在 .claude/settings.json 中添加:

{
  "mcpServers": {
    "github": {
      "command": "uvx",
      "args": ["mcp/github"]
    }
  }
}

Codex CLI 配置

Codex CLI 默认读取项目内的 .codex/ 目录。将skill复制到 .codex/skills/dachuang-report/ 即可自动加载。

如需启用GitHub集成,可在项目根目录创建 .codex/settings.local.json

{
  "env": {
    "GITHUB_PERSONAL_ACCESS_TOKEN": "your-github-pat-here"
  }
}

连接词替换词库

高频词 语境 推荐替换
基于…(方法类) 基于深度学习的… 利用…/以…为核心/借助…
基于…(依据类) 基于以上分析 由此/鉴于上述分析
围绕…(目标类) 围绕这一问题 针对…/为了解决…/以此为切入点
在此基础上 泛用 进一步地/顺延这一逻辑/以前者为前提
实现了 实现了XX功能 支持了/建立了/使XX成为可能
由此 泛用 从而/这使得/相应地

📚 参考资源

文件 内容 何时读
references/chapter-guide.md 各章节详细改写示例,含低→高质量对比 改写具体章节时
references/sentence-patterns.md 工科报告常用句式模板库,按功能分类 需要具体措辞时
references/domain-examples.md 六大工科方向的领域专用写作模式 确认工科方向后立即读

🤝 贡献

我们欢迎所有形式的贡献,包括但不限于:

  • 🐛 报告Bug
  • 💡 提出新功能建议
  • 📖 完善文档
  • 🎨 提交PR

请参考 CONTRIBUTING.md 了解详细的贡献流程。


📄 许可证

本项目采用 MIT 许可证 - 详见 LICENSE 文件


🙏 致谢

  • 感谢所有为本项目贡献代码和文档的开发者
  • 感谢 Anthropic 提供 Claude AI 技术支持
  • 感谢 GitHub 提供代码托管平台

Made with ❤️ for 的大学生创新创业训练计划项目
如果你觉得这个项目有帮助,请给我们一个 ⭐

GitHub反馈问题联系我们


About

AI-assisted writing skill for engineering undergraduate innovation project final reports and structured defense materials.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors