Skip to content

Commit 82fcbea

Browse files
authored
docs: Abstract Document readme improvements (#2569)
* readme improvements * fix typo
1 parent b285b9b commit 82fcbea

File tree

1 file changed

+24
-6
lines changed

1 file changed

+24
-6
lines changed

abstract-document/README.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ tag:
88

99
## Intent
1010

11-
Use dynamic properties and achieve flexibility of untyped languages while keeping type-safety.
11+
The "Abstract Document" design pattern is a structural design pattern that aims to provide a consistent way to handle
12+
hierarchical and tree-like data structures by defining a common interface for various document types.
1213

1314
## Explanation
1415

@@ -18,7 +19,7 @@ set of interfaces.
1819

1920
Real world example
2021

21-
> Consider a car that consists of multiple parts. However we don't know if the specific car really has all the parts, or just some of them. Our cars are dynamic and extremely flexible.
22+
> Consider a car that consists of multiple parts. However, we don't know if the specific car really has all the parts, or just some of them. Our cars are dynamic and extremely flexible.
2223
2324
In plain words
2425

@@ -175,11 +176,28 @@ And finally here's how we construct and use the `Car` in a full example.
175176
176177
## Applicability
177178
178-
Use the Abstract Document Pattern when
179+
This pattern is particularly useful in scenarios where you have different types of documents that share some common
180+
attributes or behaviors, but also have unique attributes or behaviors specific to their individual types. Here are
181+
some scenarios where the Abstract Document design pattern can be applicable:
179182
180-
* There is a need to add new properties on the fly
181-
* You want a flexible way to organize domain in tree like structure
182-
* You want more loosely coupled system
183+
* Content Management Systems (CMS): In a CMS, you might have various types of content such as articles, images, videos, etc. Each type of content could have shared attributes like creation date, author, and tags, while also having specific attributes like image dimensions for images or video duration for videos.
184+
185+
* File Systems: If you're designing a file system where different types of files need to be managed, such as documents, images, audio files, and directories, the Abstract Document pattern can help provide a consistent way to access attributes like file size, creation date, etc., while allowing for specific attributes like image resolution or audio duration.
186+
187+
* E-commerce Systems: An e-commerce platform might have different product types such as physical products, digital downloads, and subscriptions. Each type could share common attributes like name, price, and description, while having unique attributes like shipping weight for physical products or download link for digital products.
188+
189+
* Medical Records Systems: In healthcare, patient records might include various types of data such as demographics, medical history, test results, and prescriptions. The Abstract Document pattern can help manage shared attributes like patient ID and date of birth, while accommodating specialized attributes like test results or prescribed medications.
190+
191+
* Configuration Management: When dealing with configuration settings for software applications, there can be different types of configuration elements, each with its own set of attributes. The Abstract Document pattern can be used to manage these configuration elements while ensuring a consistent way to access and manipulate their attributes.
192+
193+
* Educational Platforms: Educational systems might have various types of learning materials such as text-based content, videos, quizzes, and assignments. Common attributes like title, author, and publication date can be shared, while unique attributes like video duration or assignment due dates can be specific to each type.
194+
195+
* Project Management Tools: In project management applications, you could have different types of tasks like to-do items, milestones, and issues. The Abstract Document pattern could be used to handle general attributes like task name and assignee, while allowing for specific attributes like milestone date or issue priority.
196+
197+
The key idea behind the Abstract Document design pattern is to provide a flexible and extensible way to manage different
198+
types of documents or entities with shared and distinct attributes. By defining a common interface and implementing it
199+
across various document types, you can achieve a more organized and consistent approach to handling complex data
200+
structures.
183201

184202
## Credits
185203

0 commit comments

Comments
 (0)