# doc **Repository Path**: dreamer_rent/doc ## Basic Information - **Project Name**: doc - **Description**: No description available - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-02-25 - **Last Updated**: 2026-02-25 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # 租赁管理系统文档 ## 1. 文档信息 | 属性 | 值 | |------|-----| | 文档版本 | v1.0.0 | | 创建日期 | 2024-06-01 | | 最后更新 | 2026-02-25 | | 文档状态 | 已发布 | | 文档类型 | 项目入口文档 | | 文档作者 | 项目组 | | 文档审核 | 技术负责人 | | 相关文档 | [系统架构](architecture/system-architecture.md), [系统说明](overview/system-description.md) | ## 2. 变更记录 | 版本号 | 变更日期 | 变更内容 | 变更人 | 审核人 | |--------|----------|----------|--------|--------| | v1.0.0 | 2024-06-01 | 初始版本,创建项目文档体系 | 项目组 | 技术负责人 | | v1.0.1 | 2024-11-18 | 规范化文档格式,补充元数据 | 系统 | - | | v1.0.2 | 2026-02-25 | 根据报告文档更新文档引用路径,优化侧边栏导航 | 系统 | - | ## 3. 文档概述 本目录包含租赁管理系统的完整技术文档,涵盖功能设计、API规范、数据库设计、开发指南等核心内容。本文档旨在为开发团队提供统一的技术参考,确保系统开发的一致性和规范性。 ## 4. 目录结构 ``` doc/ ├── meta/ # 元数据和配置文件 │ ├── _sidebar.md # 侧边栏配置 │ ├── index.html # 首页配置 │ └── DOCSIFY_README.md # Docsify配置 ├── archive/ # 归档文档目录 │ ├── temp-docs/ # 临时文档归档 │ └── deprecated/ # 过时文档归档 ├── analysis/ # 分析报告目录 │ ├── 需求分析报告.md │ ├── 任务规划报告.md │ ├── 任务拆分报告.md │ ├── architecture-optimization-verification.md │ ├── data-design-optimization-report.md │ ├── data-design-verification-report.md │ └── terminology-verification-report.md ├── api/ # API接口文档目录 │ ├── api-reference.md # API参考文档 │ ├── auth-api.md # 认证API │ ├── contract-api.md # 合同API │ ├── maintenance-api.md # 维修API │ └── ... ├── architecture/ # 架构设计文档目录 │ ├── system-architecture.md │ ├── tech-architecture-overview.md │ ├── saas-multi-tenant-architecture.md │ ├── architecture-optimization-plan.md │ ├── architecture-decision-records.md │ ├── implementation-plan.md │ └── system-specification.md ├── data-model/ # 数据模型文档目录(统一目录) │ ├── README.md # 数据模型概述 │ ├── database/ # 数据库设计文档 │ │ ├── README.md │ │ ├── complete-schema.sql │ │ ├── complete-schema-v2.sql │ │ ├── insert-sample-data.sql │ │ ├── database-optimization-report.md │ │ └── application-code-update-guide.md │ └── models/ # 数据模型文档 │ ├── README.md │ ├── core-data-model.md │ ├── data-model-reference.md │ ├── multi-tenant-data-model.md │ ├── data-access-spec.md │ ├── asset-models.md │ ├── contract-models.md │ └── maintenance-models.md ├── deployment/ # 部署文档目录 │ ├── README.md │ └── deployment-guide.md ├── development/ # 开发指南目录 │ ├── README.md │ ├── service-refactoring-guide.md │ ├── frontend/ # 前端开发文档 │ ├── backend/ # 后端开发文档 │ └── guide/ # 开发指南 ├── fdd/ # 功能设计文档目录 │ ├── rent-system-specification-V1.0.md │ ├── state-dictionary.md │ ├── cross-module-process-flows.md │ ├── core/ # 核心功能设计 │ ├── contract/ # 合同管理功能设计 │ ├── maintenance/ # 维修管理功能设计 │ │ └── MANAGEMENT_OPTIMIZATION_V2.0.md │ ├── cleaning/ # 保洁管理功能设计 │ ├── renovation/ # 装修管理功能设计 │ ├── item/ # 物品管理 │ ├── asset-maintenance-library/ │ ├── collection-center/ │ ├── customer-visit-management/ │ ├── financial-reporting/ │ ├── inspection/ │ ├── room-reservation/ │ ├── tenant-switch-management/ │ ├── viewing/ │ └── ... ├── overview/ # 项目概览目录 │ ├── README.md │ ├── prd.md │ ├── system-description.md │ ├── quickstart.md │ ├── index.md │ └── validation-report.md ├── standards/ # 文档标准规范目录 │ ├── README.md │ ├── document-classification-standard.md │ ├── document-format-standard.md │ ├── refactoring-completion-report.md │ ├── api/ # API规范 │ │ ├── api-development-specification.md │ │ └── multi-tenant-api-spec.md │ ├── data/ # 数据规范 │ │ ├── unified-data-model-specification.md │ │ └── data-dictionary.md │ ├── status/ # 状态规范 │ │ └── unified-status-code-dictionary.md │ ├── code/ # 代码规范 │ │ ├── technical-specification.md │ │ └── service-layer-responsibility.md │ ├── business/ # 业务规范 │ │ ├── terminology.md │ │ └── cross-module-process-flows.md │ └── templates/ # 文档模板 │ ├── api-template.md │ ├── db-template.md │ ├── fdd-template.md │ ├── guide-template.md │ ├── tech-template.md │ └── test-template.md ├── technical/ # 技术实现指南目录 │ ├── web-implementation-guide.md │ ├── mobile-implementation-guide.md │ └── miniprogram-implementation-guide.md ├── testing/ # 测试验收文档目录 │ ├── README.md │ ├── acceptance-criteria.md │ ├── house-management-acceptance.md │ ├── tenant-management-acceptance.md │ ├── contract-management-acceptance.md │ └── finance-management-acceptance.md ├── user-guide/ # 用户指南目录 │ ├── README.md │ ├── landlord-guide.md │ ├── landlord-property-publish.md │ ├── tenant-guide.md │ ├── tenant-login.md │ ├── platform-user-management.md │ └── local-post-system-guide.md ├── other/ # 其他文档目录 │ ├── faq.md │ └── maintenance.md ├── project-management/ # 项目管理文档目录 │ ├── development-plan.md │ ├── requirement-mapping.md │ ├── implementation-steps.md │ ├── document-versioning.md │ ├── changelog.md │ ├── module-status.md │ └── document-optimization-completion-report.md ├── tasks/ # 任务文档目录 │ ├── 0001-backend-implementation-tasks.md │ ├── 0001-prd-item-increase-decrease.md │ ├── 0002-prd-operation-audit.md │ ├── 0003-frontend-implementation-spec.md │ ├── 0004-item-inventory-management-implementation.md │ ├── 0005-unified-audit-log-implementation.md │ ├── 0006-house-detail-tabs-implementation.md │ ├── 0007-unified-table-modal-implementation.md │ ├── 0008-unified-file-upload-service.md │ ├── 0009-module-acceptance-checklist.md │ ├── 0010-table-structure-documentation.md │ ├── 0011-process-nodes-documentation.md │ ├── 0012-state-linkage-documentation.md │ └── 0013-permission-verification-documentation.md ├── models/ # 数据模型文档(保留) │ ├── README.md │ ├── core-data-model.md │ ├── data-model-reference.md │ ├── multi-tenant-data-model.md │ ├── data-access-spec.md │ ├── asset-models.md │ ├── contract-models.md │ └── maintenance-models.md ├── database/ # 数据库文档(保留) │ ├── README.md │ ├── complete-schema.sql │ ├── complete-schema-v2.sql │ ├── insert-sample-data.sql │ ├── database-optimization-report.md │ └── application-code-update-guide.md ├── data-model-reference.md # 数据模型参考 ├── index.md # 文档索引 ├── README.md # 文档入口 ├── check-tech-stack.sh # 技术栈检查脚本 └── start-docs.sh # 启动文档服务脚本 ``` ## 5. 目录优化说明 本目录结构经过全面优化,遵循以下原则: 1. **模块化**:将大型功能设计文档拆分为小功能模块,保持单一职责 2. **分层清晰**:将API、前端、后端、数据库、数据模型等内容分别归类 3. **标准化**:统一文档格式和命名规范,提高可维护性 4. **多端支持**:每个功能模块包含针对Web、App、小程序的实现说明 5. **版本控制**:建立完整的文档版本管理机制 请所有团队成员严格遵循此文档规范进行开发和维护工作。 ## 6. 文档规范 ### 6.1 文档编写规范 #### 6.1.1 功能设计文档 功能设计文档应遵循[standard-template.md](functional-design/standard-template.md)的标准结构,包含以下内容: - 功能概述:描述功能目标、用户价值和适用范围 - 交互逻辑:详细说明用户操作流程,使用Mermaid图表展示 - 数据模型:定义核心数据实体和关系 - API概要:提供相关API的简要说明 - 技术要求:列出功能实现的技术要点 - 质量要求:明确功能质量和性能指标 - 验收标准:制定功能验收的具体标准 - 关联文档:引用相关的其他文档 #### 6.1.2 API文档 API文档应包含以下内容: - 接口概述:说明API的功能和用途 - 接口路径和方法:详细的API端点信息 - 请求参数:所有请求参数的说明,包括类型、是否必填等 - 响应格式:成功和失败响应的JSON结构 - 错误码说明:可能出现的错误码及其含义 #### 6.1.3 数据库文档 数据库文档应包含以下内容: - 表结构定义:字段名、数据类型、约束条件、描述 - 索引设计:各类索引的名称、字段和用途 - 表间关系:通过ER图展示表之间的关联关系 - 数据迁移策略:说明数据变更的管理方式 ### 6.2 文档版本控制机制 1. **版本号格式**:采用语义化版本号(Major.Minor.Patch) - Major:不兼容的API变更 - Minor:向后兼容的功能性新增 - Patch:向后兼容的问题修复 2. **文档更新记录**:每个文档应包含更新记录部分,记录版本变更内容 3. **变更审核**:重要文档变更需经过团队审核后发布 ### 6.3 命名规范 - 文件名使用小写字母,多个单词用连字符(-)分隔 - 文档标题使用一级标题(#) - 章节使用二级标题(##)和三级标题(###) - 代码块使用适当的语言标识 ## 7. 多端开发规范 系统支持Web端、App端和小程序端多端访问,各端开发应遵循[multi-platform-specification.md](functional-design/multi-platform-specification.md)中定义的规范: - **功能差异**:明确各端支持的功能范围和优先级 - **技术实现**:遵循各端的技术栈和开发最佳实践 - **数据交互**:统一API设计原则,保证数据一致性 - **UI/UX适配**:根据各平台特性优化用户界面和交互体验 ## 8. 文档使用指南 ### 8.1 新功能开发流程 1. 参考标准模板创建功能设计文档 2. 拆分功能为独立子模块,创建对应文档 3. 在相应目录下创建API、数据库和实现方案文档 4. 确保文档间引用关系正确 5. 更新相关README文件 ### 8.2 文档维护 1. 功能变更时同步更新相关文档 2. 定期审查文档内容,确保准确性 3. 文档版本与代码版本保持一致 4. 废弃功能的文档归档保存 ### 8.3 文档交叉引用 文档间引用应使用相对路径,例如: ```markdown 详细API说明请参考[contract-api.md](api/contract-api.md) ``` ## 9. 质量要求 ### 9.1 文档完整性 - 所有功能模块必须有对应的设计文档 - 文档内容应完整覆盖需求范围 - 术语和定义应统一和清晰 ### 9.2 文档准确性 - 文档内容应与实际实现保持一致 - 流程图和模型图应准确反映业务逻辑 - 示例代码应可执行且符合规范 ### 9.3 文档可读性 - 使用清晰简洁的语言 - 合理使用图表和示例 - 遵循统一的格式和风格 ## 10. 相关资源 - **开发工具推荐**:VS Code、Markdown Preview Enhanced - **图表绘制工具**:Mermaid、draw.io - **文档协作平台**:GitBook、Confluence --- *本文档由租赁管理系统开发团队维护,最后更新时间:2024年6月*
📖 新手入门快速开始项目概述 术语表 |
🔌 API 接口接口规范API 参考 多租户 API |
💻 开发指南环境搭建开发规范 状态码字典 数据模型规范 服务层规范 开发逻辑 |
🚀 部署运维部署指南运维手册 系统维护 |
| 模块 | 核心功能 | 相关文档 |
|---|---|---|
| 🏠 房源管理 |
• 项目录入与房型配置 • 房源状态可视化 • 空置预警管理 • 房源档案全生命周期 |
系统规格说明 功能设计 |
| 👥 租客管理 |
• 租客信息录入与档案 • 电子合同在线签署 • 租约续签/换房/解约 • 退租结算自动化 |
功能设计 合同创建 |
| 💰 财务管理 |
• 账单自动生成与推送 • 在线支付与线下登记 • 欠款催缴与违约金 • 多维度财务报表 |
收款中心 财务报表 |
| 📋 合同管理 |
• 合同模板与条款配置 • 电子签约流程 • 合同到期提醒 • 合同档案管理 |
功能设计 合同API |
| 🏠 预定管理 |
• 房源预定与占房 • 定金支付与管理 • 预定状态跟踪 • 定金转换与违约处理 |
房间预定 预定API文档 |
| 🔧 运维管理 |
• 维修报单与派工 • 保洁任务管理 • 装修工程管理 • 装修进度跟踪 • 装修费用控制 • 装修验收评价 • 运维成本核算 |
维修管理 保洁管理 装修管理 装修API文档 |
| 📦 物品管理 |
• 物品库存管理 • 物品流转记录 • 物品价格配置 • 物品领用与归还 |
物品管理 物品API文档 |
| 🔒 审计管理 |
• 操作日志记录 • 字段差异对比 • 风险操作预警 • 审计报告导出 |
操作日志 审计API文档 |
| 📊 数据中心 |
• 运营数据看板 • 智能预警系统 • 统计分析报表 • 数据导出功能 |
产品设计 业务流程 |
| 🔄 跨模块流程 |
• 租约创建跨模块流程 • 租约解约跨模块流程 • 维修工单跨模块流程 • 事件驱动架构 |
跨模块业务流程 数据模型规范 |