Project Docs

Vibe Coding 规则知识库 · AGENTS.md

在线查看上传的 Markdown 项目文档。

  • 所有的路径都使用相对路径;
  • 所有端口都不要使用常用端口,并且做成可配置的;
  • 使用docker技术,至少需要在Linuxos中可以部署运行;
  • git版本管理(待补充)
  • 文档管理(待补充)
  • 项目至少必须包含readme.md文档,PRD.md文档,所有文档里都必须有目录,并且在项目主目录下创建docs文件夹存放,例如程序目录路径为/Users/mac/workspace/ItemMark,则存放文档的路径为/Users/mac/workspace/ItemMark/docs,每次功能变更后,都必须更新文档;
  • 项目开始编写代码之前的前端Mock原型相关的文件,都存放到项目主目录下的webMock文件夹下,例如程序目录路径为/Users/mac/workspace/ItemMark,则存放文档的路径为/Users/mac/workspace/ItemMark/webMock,webMock文件夹中的内容可以被正式代码参考使用,但是禁止正式代码直接指向webMock中的内容;
  • readme.md文档包含模块:功能介绍、程序部署方式、运行环境、操作方式、常用命令;
  • PRD.md文档包含模块:

项目概述 目标与范围 用户与角色 业务流程 功能需求 页面与交互 数据模型 接口定义 业务规则 非功能要求 验收标准 技术与实现约束

  • 如果有数据库,则需要一个DatabaseSchema.md文档来说明每个表每个字段的作用,含义,影响范围,并且每次增加、删除表或表中的字段时,都需要更新DatabaseSchema.md文档;
  • 所有可配置的东西不要在代码中写死,保留可配置的功能,需要有配置文件+配置维护Web页面;
  • 每次修改代码并测试完成之后,都必须同步修改对应的文档;
  • 遇到网络问题,尝试使用代理(http/https)

​ 192.168.1.27:20171

​ 192.168.1.7:20171

​ 192.168.66.37:10809