42 lines
2.9 KiB
Markdown
42 lines
2.9 KiB
Markdown
# GEMINI.md - Fujian Water Revenue System Documentation
|
|
|
|
## Directory Overview
|
|
|
|
This directory contains the comprehensive design documentation for the Fujian Water Revenue System. The project is a non-code project, focusing on the detailed documentation of a software system. The documentation is written in Markdown and can be exported to various formats like Word, PDF, and HTML using the provided `Makefile`.
|
|
|
|
The system is designed as a modern, microservices-based application for managing a water utility's revenue operations. It utilizes a tech stack centered around Java (RuoYi-Vue-Pro framework) and Vue.js for the frontend, with a notable use of the OpenGauss database, a domestic Chinese database solution.
|
|
|
|
## Key Files
|
|
|
|
* `README.md`: Provides a high-level overview of the project, its status, and key deliverables.
|
|
* `Makefile`: Contains a set of commands for managing the documentation, including validation, exporting to different formats, and other maintenance tasks.
|
|
* `water_biz_system_architecture.md`: Describes the overall system architecture, including the technology stack, deployment model, and security considerations.
|
|
* `water_biz_module_design.md`: Details the design of each module in the system, including business logic, user interfaces, and API specifications.
|
|
* `water_biz_database_design.md`: Provides a complete data model for the system, including table structures, relationships, and strategies for performance optimization and security.
|
|
* `new_doc/`: This directory contains the final, polished versions of the design documents in `.docx` format.
|
|
* `ori_doc/`: This directory contains the original source documents and requirements that the design is based on.
|
|
* `output/`: This directory contains the exported versions of the documentation in various formats (Word, PDF, HTML).
|
|
* `scripts/`: This directory contains various scripts used by the `Makefile` to manage and process the documentation.
|
|
|
|
## Usage
|
|
|
|
The primary purpose of this directory is to house the design documentation for the Fujian Water Revenue System. The `Makefile` provides a convenient way to manage and export the documentation.
|
|
|
|
**Common `make` commands:**
|
|
|
|
* `make help`: Displays a list of all available commands.
|
|
* `make validate`: Validates all the documentation files.
|
|
* `make export-word`: Exports the documentation to Microsoft Word format.
|
|
* `make export-pdf`: Exports the documentation to PDF format.
|
|
* `make export-html`: Exports the documentation to HTML format.
|
|
* `make unified-export`: A recommended command to export the documentation to all formats, ensuring consistency.
|
|
* `make quick-export`: A faster export option that doesn't process diagrams.
|
|
|
|
To use these commands, simply run them from the root of the project directory in your terminal. For example:
|
|
|
|
```bash
|
|
make unified-export
|
|
```
|
|
|
|
This will generate the complete documentation set in the `output/` directory.
|