# 摸鱼不队——代码规范、冲刺任务与计划

moon-star-art moon-star-art 墨衍会员 · AI 创作全网分发 墨衍智能分发 通过墨衍一键同步至各平台 可同步平台 CSDN微信公众号微博知乎掘金百家号博客园抖音小红书 你的文章也可以这样分发 墨衍会员 ¥399起/年,写一次发全网 我也要 + 加入社区

摸鱼不队——《疙瘩瘟》α冲刺:代码规范、冲刺任务与计划

项目内容
这个作业属于哪个课程202601福大-软件工程实践-W班
这个作业要求在哪里软件工程实践团队作业——站立式会议+α冲刺
团队名称摸鱼不队
这个作业的目标制定团队代码规范,明确七天 α 冲刺任务与计划,并说明 AI 技术员(设计师/程序员/测试员等)如何辅助团队完成任务
其他参考文献《构建之法》第2章、第13章;《阿里巴巴Java开发手册》终极版 v1.3.0;华为内部代码规范

本篇用于记录摸鱼不队团队在 α 冲刺开始前确定的代码规范、冲刺任务、计划安排与 AI 协作方式。项目为明末鼠疫题材 Ren'Py 视觉小说《疙瘩瘟》,技术栈为 Python(Ren'Py)+ SQLite,并配套 Python 标准库自动化测试。代码规范服务于后续实现,冲刺计划为阶段性安排。

目录

  • 摸鱼不队——《疙瘩瘟》α冲刺:代码规范、冲刺任务与计划
  • 一、团队代码规范
  • 1.1 规范的适用范围
  • 1.2 通用原则
  • 1.3 项目目录和模块边界
  • 1.4 命名规范
  • 1.5 分层与解耦
  • 1.6 数据访问与数据库
  • 1.7 注释与异常
  • 1.8 测试与质量检查
  • 1.9 Git分支、提交和评审规范
  • 二、AI 技术员协作规范
  • 2.1 AI 在团队中的角色
  • 2.2 驱动 AI 工作的提示词模板
  • 2.3 AI 协作流程
  • 2.4 三类代表性使用场景
  • 场景一:AI 辅助设计存档/结局数据访问层
  • 场景二:AI 辅助生成测试用例
  • 场景三:AI 辅助美术归位与命名对照
  • 2.5 AI 输出的采纳标准
  • 三、α冲刺任务与计划
  • 3.1 冲刺目标
  • 3.2 冲刺任务拆分
  • 3.3 七天冲刺时间表(10-23 ~ 10-29)
  • 3.4 团队成员分工
  • 3.5 交付物清单
  • 四、结语

一、团队代码规范

1.1 规范的适用范围

本规范适用于本项目的前端(Ren'Py 界面与剧情脚本)、数据访问层(存档/结局/会话/选择日志读写)、数据库脚本、测试代码、配置文件与 Git 提交。当前系统为 Ren'Py 视觉小说 + SQLite 本地数据库,实际依赖版本以代码仓库为准。规范的目的不是增加形式化工作,而是让不同成员、不同开发阶段以及 AI 生成的代码保持一致,降低联调、审查和后续维护成本。

1.2 通用原则

  1. 先理解需求,再编写代码。 开发前先明确功能边界、输入输出、异常情况和验收方式,不直接根据模糊描述生成大段代码。
  2. 单一职责。 一个函数、一个模块或一个界面只处理清晰的一类职责,避免把数据读写、业务判断和界面展示混在一起。
  3. 优先可读性。 代码首先服务于团队阅读和维护,不为了减少行数而牺牲命名、结构和错误提示的清晰度。
  4. 保持已有约定。 修改已有模块前先阅读同目录代码、接口文档和测试,不随意引入与当前项目不一致的框架、依赖或编程风格。
  5. 最小必要修改。 一个任务只修改与该任务相关的文件,不在无关文件中顺手重构,避免增加评审范围和合并冲突。
  6. 所有修改都可验证。 完成功能后至少执行对应的脚本检查、界面运行或数据库测试,并在提交说明中写明验证结果。

1.3 项目目录和模块边界

项目以 Ren'Py 标准目录为基础,新增模块遵循"按职责划分、按领域聚合"的原则,目录结构如下:

GedaWen/
├─ game/                  # Ren'Py 引擎根目录(唯一被运行时读取)
│ ├─ images/              # 图片资源(bg 背景 / char 立绘 / ui 界面)
│ │ ├─ bg/                # 背景图
│ │ ├─ char/              # 角色立绘
│ │ └─ ui/                # 界面元素
│ ├─ gui/                 # GUI 配置,window_icon.png 等
│ ├─ saves/               # 运行期自动生成的原生存档(不提交 git)
│ ├─ script.rpy           # 主剧情入口(doctor / citizen / officer 三线)
│ ├─ dao/                 # 数据访问层:存档、结局、会话、选择日志读写
│ └─ .rpy 脚本             # 界面 / 样式 / 剧情 / 结局封装
├─ database/              # SQLite 交付目录(schema / seed / 模板库 / 测试)
│ ├─ gedawen.db           # SQLite 模板库
│ ├─ schema.sql           # 六张业务表结构
│ ├─ seed.sql             # 结局种子数据
│ ├─ test_database.py     # 自动化测试
│ └─ test_results.txt     # 测试输出
└─ tools/                 # 脚本与工具

规定:Ren'Py 只读取根目录 game/,因此 art/game/ 这类嵌套层级是"死目录",美术资源统一经 art/ 验收后归位到 game/images/bg|char|ui 与 game/gui/。界面层只提交事件、不做业务判断;数据访问层集中管理 SQL。

1.4 命名规范

对象规范示例
Python 变量 / 函数snake_case,语义清晰、避免无意义缩写slot_number、list_unlocked()
Python 类CamelCase,使用名词或名词短语SaveDao、EndingDao
常量UPPER_SNAKE_CASEDEFAULT_PROFILE
Ren'Py label与数据库 node_code / 结局 ID 一一对应,命名即契约doctor_line、e_book、wuguan_iron
数据库表名snake_case,带域前缀便于归属player_profile、ending_unlock
美术文件名去掉扩展名后 = 剧情中引用名bg_chengmen.png → scene bg_chengmen

方法与变量名要体现业务含义,禁止使用 a、b、data1、temp 等无法表达意图的名称;局部短变量仅限作用域很小且含义明确的场景。

1.5 分层与解耦

  1. 界面层只提交事件、不做业务判断,存读档、图鉴等操作调用数据访问层方法,延续职责单一原则。
  2. 剧情脚本只调接口方法、不直接写 SQL,SQL 集中在数据访问层用参数化查询封装。
  3. 新增剧情不动他人文件:三线剧情按 doctor / citizen / officer 分文件维护,避免合并冲突。

1.6 数据访问与数据库

  1. 参数化查询一律使用 ? 占位符,禁止字符串拼接用户输入,防止 SQL 注入。
  2. 写操作用事务包裹,保证档案、图鉴、游玩、选择记录要么全部成功、要么全部回滚,避免业务层部分成功。
  3. 每次连接启用外键,由数据库保证级联删除与引用完整性;删除档案级联删除其存档、图鉴、游玩及选择记录。
  4. 主外键、唯一/非空/CHECK 约束在 schema.sql 统一定义,不在业务层临时拼接。
  5. 原生存档必须按档案实现隔离:采用独立存档路径或槽命名映射,不能只靠数据库区分 profile_id,防止底层文件互相覆盖。
  6. 数据库只保存元数据,不保存完整运行状态、不执行剧情;current_label / target_label 等标签由程序对照 .rpy 校验。

1.7 注释与异常

  1. 注释贴近代码、与代码同行,说明"为什么"而非复述"是什么"。
  2. 函数/类加 docstring;关键逻辑(结局解锁幂等、HMAC 校验、原生存档隔离)必须注释。
  3. 通用异常用简洁 try/except 统一捕获,不逐处堆 try;不用空 catch 块吞掉异常,异常要么被合理处理、要么上抛并保留上下文日志。
  4. 不把密码、Token、数据库连接串、个人隐私写入日志,日志内容满足排查需要并遵守最小暴露原则。

1.8 测试与质量检查

测试至少覆盖正常路径、边界输入、空数据、权限错误和依赖服务异常五类场景。对于存档读写、结局解锁、级联删除,要覆盖:档案切换、结局首次解锁幂等、级联删除、SHA256 不变校验、时间与顺序约束。

提交前检查清单:

  • 当前修改能通过脚本检查或界面运行;
  • 新增业务方法有对应的自动化测试或明确的验证记录;
  • 正常、空数据和异常状态均有验证;
  • 数据库脚本能在测试环境执行;
  • 没有提交密码、Token、个人隐私和本地临时文件;
  • 没有提交 saves/ 下运行期自动生成的存档、persistent 等文件;
  • 代码经过至少一名其他成员阅读或联调确认;
  • 提交说明能说明修改目的和验证结果。

1.9 Git分支、提交和评审规范

团队使用功能分支开发,master 仅用于发布,合并需 PM + 至少一人 review。分支命名如下:

分支类型命名示例用途
功能分支feature/art、feature/user-db新增一个完整功能/交付
剧情分支feature/doctor-line、feature/citizen-line、feat/officer-line三线剧情开发
界面分支feature/ui、ui-system界面与系统

提交信息使用"类型 + 中文说明"的形式:

feat(dao): 接入存档读写
fix(ui): 结局图鉴不亮
art(bg): 新增城门外背景
test(db): 补级联删除用例
docs: 更新接口调用示例
refactor: 拆分数据访问方法

提交要求:

  1. 一次提交只表达一个可解释的修改目的;
  2. 完成一个功能并通过基本验证后及时提交,不把多个无关功能堆到最后一次提交;
  3. 每天至少一次代码签入,开发成员当天工作必须有 commit,并在冲刺随笔附提交记录/截图;
  4. 提交前检查改动范围,避免把 IDE 配置、构建产物、临时截图和运行期存档提交到仓库;
  5. 合并前由提交者说明改动内容、测试方式和已知问题,至少一名成员完成代码阅读或联调;
  6. 发生冲突时先同步主分支,再逐项解决并重新验证,不直接覆盖队友的有效修改。

二、AI 技术员协作规范

2.1 AI 在团队中的角色

本项目把 AI 作为受人工管理的技术协作者,不把 AI 生成结果视为自动通过的代码。根据任务类型,将 AI 分为四个协作角色:

AI 角色主要工作人工负责人最终验证
AI 程序员提供数据访问层、SQL、剧情接入和测试代码的初稿,辅助定位报错陈宇杰、范自亮、赫庆国、卢宗园人工阅读、运行、联调和代码评审
AI 测试员根据表结构与约束生成测试场景,检查边界输入、级联删除和异常流程陈宇杰执行测试、核对实际结果并保留测试记录
AI 设计师拆分美术资源、补充图名引用对照、给分辨率/格式/命名建议吴昊、袁志华对照美术归位规范和剧情引用名检查
AI 规划员任务拆解、进度分析、燃尽图数据整理、文档润色谭培(PM)对照冲刺计划与每日随笔核对

AI 不直接决定项目范围,不直接提交或合并代码,不接触真实密码、Token、数据库账号和未授权数据。任何 AI 生成内容都必须经过成员确认后才能进入分支或文档。

2.2 驱动 AI 工作的提示词模板

团队使用结构化提示词,尽量减少"帮我写一个功能"这类上下文不足的请求。通用模板如下:

你现在承担的角色:AI程序员 / AI测试员 / AI设计师 / AI规划员

项目背景:明末鼠疫题材 Ren'Py 视觉小说《疙瘩瘟》,技术栈 Python + SQLite
当前任务:明确要解决的一个问题,不扩大任务范围
已有上下文:相关脚本、表结构、界面文件、错误信息或美术目录
技术约束:遵循当前项目已有命名、分层和数据库设计,Ren'Py 只读根目录 game/
禁止事项:不要修改未授权文件,不编造不存在的接口、字段或依赖
输出要求:先说明方案,再给出最小必要修改,最后列出验证步骤
验收标准:能通过哪些脚本检查、界面运行、数据库测试或对照表核对

提交给 AI 的上下文只包含完成任务所需的最小范围。对于需要修改代码的任务,先让 AI 说明修改文件和设计思路,再决定是否让其生成代码;对于错误排查,提供错误信息、复现步骤和相关代码,不直接上传整个仓库。

2.3 AI 协作流程

成员提出问题
 ↓
明确上下文、边界和验收标准
 ↓
AI 给出方案或代码初稿
 ↓
成员逐行阅读并标记采纳、修改、拒绝内容
 ↓
运行脚本检查、界面运行或数据库测试
 ↓
代码评审与提交记录
 ↓
把有效经验补充到规范或 Issue 中

每次重要的 AI 协作至少留下以下信息:任务背景、使用的提示词、AI 输出摘要、人工修改点、采纳或拒绝理由、验证结果和对应的提交/Issue。AI 输出中的版本号、依赖、接口、字段和外部资料必须由成员实际核对,不能因为表述完整就直接当成事实。

2.4 三类代表性使用场景

场景一:AI 辅助设计存档/结局数据访问层

成员向 AI 提供表结构(game_save、ending_unlock)、约束和需求,要求 AI 整理数据访问方法(存档写入/读取、结局解锁幂等、图鉴查询)的草案。AI 先输出方法签名和 SQL 初稿,团队再对照 schema.sql 检查字段是否真实存在。

采纳内容:参数化查询写法、结局首次解锁幂等处理、按档案隔离存档的建议。

人工修改:删除 AI 自行假设的不存在字段,按项目实际补充事务包裹、每次连接启用外键和异常处理。

验证方式:运行 test_database.py 及新增用例,检查级联删除、结局首次解锁幂等和 SHA256 不变。

场景二:AI 辅助生成测试用例

成员向 AI 提供六张表结构、约束和 schema.sql,要求 AI 生成 unittest 用例,覆盖正常路径、边界输入和异常路径。AI 补充档案切换、结局首次解锁幂等、级联删除、空数据、时间与顺序约束等场景。

采纳内容:边界用例(空数据、非法输入、级联删除、重复解锁)的补充。

拒绝内容:AI 提出的修改数据库结构或跳过的外键校验等超范围方案,不直接采用。

验证方式:执行测试、保留测试结果截图(test_results.txt),在提交记录中关联对应 Issue。

场景三:AI 辅助美术归位与命名对照

成员向 AI 提供美术资源清单和剧情脚本的引用名,要求 AI 生成"图名 ↔ 脚本引用名"对照表,并给分辨率/格式/命名建议,明确图标应转 PNG 并命名为 window_icon。

采纳内容:对照表整理、英文命名建议、按类型归位到 bg/char/ui 的建议。

人工修改:删除 AI 推测出的不存在资源名,按实际脚本引用核对每张图。

验证方式:归位后在剧情节点运行 scene bg 名字 / show 名字,确认能正常引用显示。

2.5 AI 输出的采纳标准

检查项通过标准
需求一致性没有扩大当前任务范围,能对应已有需求或 Issue
项目一致性使用已有技术栈、目录、命名和接口约定
可验证性能通过脚本检查、界面运行、数据库测试或对照表核对
安全性不包含真实密钥,不绕过权限,不关闭必要的校验和日志审计
可维护性职责清晰,修改范围可控,团队成员能理解和接手
事实可靠性版本、字段、接口和外部资料已经由成员实际确认

不符合上述条件的输出只能作为讨论材料,不能直接合并。AI 生成的代码也必须由团队成员承担理解、验证和维护责任。

三、α冲刺任务与计划

3.1 冲刺目标

把当前"三线剧情 + 数据库已实现 + 界面初稿"推进到 **"可运行、可存档、可解锁结局的完整可玩版本"**,并完成 7 天站立式会议、燃尽图与全套博客交付。

3.2 冲刺任务拆分

任务编号任务名称主要内容交付标准
A1数据访问层骨架数据库文件放 game/、首次自动建表、数据访问方法签名、参数化查询/事务/外键存档、结局、会话、选择日志方法可被剧情/界面调用,测试通过
A2原生存档隔离按档案映射独立存档路径/槽命名,防止底层文件互相覆盖不同档案读写互不干扰,README 点名的风险已处理
A3三线剧情接入doctor / citizen / officer 剧情节点与结局 ID 对齐,结局解锁、选择日志写入三线各 6 个结局都能触发解锁
A4界面接入存读档界面、结局图鉴界面接数据访问层,主菜单档案切换入口界面能列槽位、写槽位、读档校验、显示已解锁/未解锁图鉴
A5美术资源归位背景/立绘/图标/封面归位到 game/images 与 game/gui剧情引用名与实际文件名一致,界面/背景能正常显示
A6自动化测试扩展档案切换、结局首次解锁幂等、级联删除、SHA256 不变等用例测试通过并保留 test_results.txt
A7集成与打磨全流程跑通、Bug 修复、燃尽图维护、博客与答辩材料形成可演示版本,留下提交、测试和文档证据

3.3 七天冲刺时间表(10-23 ~ 10-29)

冲刺日日期会议主题当天核心产出
Day 110-23冲刺动员 + 分工确认本篇《代码规范与冲刺计划》随笔、置顶集合随笔
Day 210-24数据库接入方案定稿数据访问层骨架、存读档接口对接
Day 310-25存档 / 结局打通本地存档读写 + 结局解锁联调跑通
Day 410-26剧情与界面集成三线剧情接入界面、美术资源首轮归位
Day 510-27资源补齐 + 测试背景/立绘补齐、自动化测试扩展
Day 610-28内测打磨全流程跑通、Bug 修复、发布《测试随笔》
Day 710-29冲刺总结发布《冲刺总结随笔》、答辩 PPT + 评审表

3.4 团队成员分工

成员学号冲刺任务
谭培102400227PM:燃尽图维护、分支/PR 管理、集成联调、AI 技术员统筹、随笔与答辩统筹
陈宇杰102400212数据访问层 + 测试:档案/存档读写、结局解锁、游玩与选择写入、参数化查询/事务/外键、扩展自动化测试、主写《测试随笔》
范自亮102400213郎线剧情接入数据库;答辩 PPT 制作
赫庆国102400214百姓线剧情接入数据库
卢宗园102400223武官线剧情接入数据库,保持 wuguan_* 结局 ID 与 master 一致
朱熙102400235界面:存读档界面、结局图鉴界面接数据访问层
吴昊102400228美术:三线背景图、角色立绘归位;评审表设计
袁志华102400231美术:图标/封面归位、UI 元素

3.5 交付物清单

交付物责任人截止
置顶集合随笔谭培Day 1
代码规范、冲刺任务与计划随笔(本篇)谭培Day 1
冲刺随笔 Day 1~7全员填写 + 谭培统筹每天
测试随笔陈宇杰Day 6
冲刺总结随笔谭培Day 7
答辩 PPT范自亮Day 7
评审表吴昊Day 7
代码仓库每日提交全体开发/美术成员每天

四、结语

本篇记录了团队代码规范、α 冲刺任务与计划,以及 AI 技术员的协作方式。摸鱼不队将在后续开发中按照统一规范推进实现,用 AI 辅助设计、开发和测试,并根据实际完成情况及时调整任务安排。


Day 1 冲刺动员:全组确认目标、分工、规范与 AI 技术员机制,冲刺正式启动。后续每天更新进展与燃尽图。

...全文

相关推荐

iOS 摸鱼周报 #61 |  Developer 设计开发加速器

本期概要 本期话题: Developer 设计开发加速器|探索 Create ML Components 本周学习:解决使用 AVAudioRecorder 录音保存 .WAV 文件遇到的问题 内容推荐:SwiftUI 本周好文推荐 摸一下鱼:摸鱼网站推荐 本期话题  Developer 设计开发加速器|探索 Create ML Components @...

zhangferry

一句话开发Chrome摸鱼插件

摘要: 腾讯云代码助手CodeBuddy推出Craft智能体功能,实现自然语言驱动的全栈开发。通过PyCharm插件安装后,用户仅需输入一条指令(如开发Chrome鼠标手势插件),即可自动完成需求分析、代码生成和项目构建。测试显示,生成的404页面插件包含完整功能文件,并支持手势触发跳转和返回。CodeBuddy简化了开发流程,使编程更高效直观,成为开发者的智能编程伙伴。(149字)

AI大眼萌

摸鱼还要提醒?用Python整个倒计时界面自觉摸鱼~

打工人要多注意身体!钱是老板的,但命是自己的 !

小熊猫爱恰饭

手把手教你使用Python打造一款摸鱼倒计界面

前言 前段时间在微博看到一段摸鱼人的倒计时模板,感觉还挺有趣的。 于是我用了一小时的时间写了个页面出来 摸鱼办地址 (当然是摸鱼的时间啦)。 模板是这样的: 摸鱼办公室 ???? 【摸鱼办公室】今天是 2021-11-30 星期二 你好,摸鱼人,工作再累,一定不要忘记摸鱼哦 ! 有事没事起身去茶水间去廊道去天台走走,别老在工位上坐着。多喝点水,钱是老板的,但命是自己的 ! ???? 距离 周末 放假还有 2 天 ???? 距离 元旦 放假还有 3 天 ???? 距离 过年 放假还有 3

老贡讲Python

偷偷用 Python 写了一个摸鱼监控进程

前言 上班就想摸鱼,一直上班那是不可能的,总要放松一下,摸摸鱼啥的吧。继打游戏、看视频等摸鱼行为被监控后,现在打工人离 职的倾向也会被监控。 有网友爆料称知乎正在低调裁员,视频相关部门几乎要裁掉一半。而在知乎裁员的讨论区,有网友表示企业安装了行为感知系 统,该系统可以提前获知员工跳槽念头。 而知乎在否认了裁员计划的同时,也声明从未安装使用过网上所说的行为感知系统,今后也不会启用类似软件工具。 因为此事,深信服被推上风口浪尖,舆论关注度越来越高。 一时间,“打工人太难了”“毫无隐私可言”的讨论层出不穷。 今天

蚂蚁爱Python
评论
收藏 已收藏
分享
返回顶部