This repository contains a Logseq vault dedicated to documenting the domain of a veterinary clinic, with a special focus on the ubiquitous language used within this domain. The vault aims to showcase how Logseq can be an effective tool for domain-driven design (DDD) documentation, enabling the capture and organization of complex domain knowledge in an accessible and navigable format.
- Entities and Value Objects: Detailed descriptions of the domain's entities and value objects, capturing their attributes and behaviors.
- Aggregate Roots: Documentation on the aggregate roots that ensure the integrity of the domain model.
- Repositories: Overview of repository patterns used for persisting and retrieving domain objects.
- Domain Events: Explanation of significant events within the domain and their impact on the model.
- Ubiquitous Language: A glossary of terms and language that are universally understood across the domain.
- Templates: Useful to create more of the above, following a uniform format
To explore this experiment, you'll need to have Logseq installed on your machine. Follow the steps below to get started:
-
Install Logseq: Download and install Logseq from the official website or from your preferred software distribution platform.
-
Clone the Repository: Clone this repository to your local machine using Git:
git clone git@github.com:mrdonado/logseq-ddd.git -
Open the Vault in Logseq: Open Logseq and select "Open another graph" from the menu. Navigate to the cloned repository folder and select it to open the vault.
Contributions to the veterinary clinic domain documentation are welcome! Whether it's expanding on existing topics, introducing new concepts, or improving the ubiquitous language glossary, your input can help enhance this resource.
To contribute, please follow these steps:
- Fork the repository.
- Create a new branch for your contribution (
git checkout -b feature/your_feature_name). - Make your changes in the Logseq vault.
- Commit your changes (
git commit -am 'Add some feature'). - Push to the branch (
git push origin feature/your_feature_name). - Create a new Pull Request.
This project is licensed under the MIT License - see the LICENSE file for details.
- Logseq Team for creating an incredible tool for knowledge management and documentation.
- The domain-driven design community for providing the methodologies and practices that guided the structuring of this documentation.