Skip to content

Commit 1f09654

Browse files
authored
feat(intro): add a "For Whom" section
1 parent 5771128 commit 1f09654

File tree

1 file changed

+16
-6
lines changed
  • i18n/en/docusaurus-plugin-content-docs/current

1 file changed

+16
-6
lines changed

i18n/en/docusaurus-plugin-content-docs/current/intro.mdx

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,25 @@ pagination_next: get-started/index
1111

1212
**Feature-Sliced Design** (FSD) is an architectural methodology for scaffolding front-end applications. Simply put, it's a compilation of rules and conventions on organizing code. The main purpose of this methodology is to make the project more understandable and structured in the face of ever-changing business requirements.
1313

14-
Here is how it's accomplished:
14+
## Is it right for me?
1515

16-
- A strong foundation of **time-tested** design practices:
17-
_SOLID, GRASP, DDD, Separation of Concerns, Vertical Slices, Public API, Isolation._
18-
- Project partitioning on business domains
19-
- Consistency in file structure
16+
FSD can be implemented in projects and teams of any size, but there are a few things to keep in mind:
17+
18+
- This methodology is for front-end projects only. If you're looking for a back-end architecture, consider [Clean Architecture][refs-clean-architecture].
19+
- A very simple app of a single page might not need the benefits of FSD and suffer from the overhead. However, FSD promotes a nice way of thinking, so feel free to use on the tiniest projects if you want.
20+
- A huge app, the size of the Google Cloud admin dashboard, will require a custom architecture. It could still be based on FSD, by the way 😎.
2021

21-
The methodology is not tied to any particular technology stack and is applicable to most front-end projects. This documentation contains examples in JavaScript + React, but FSD has been successfully adapted to other technology stacks (see [project examples][refs-examples]).
22+
FSD doesn't enforce a particular programming language, UI framework or state manager — bring your own or see some [examples][refs-examples].
23+
24+
If you have an existing project, fear not — FSD can be adopted incrementally. Just make sure that your team is **in pain** 😈 from the current architecture, otherwise a switch might not be worth it. <!-- For migration guidance, see the Migration section. TODO: add the migration section and link to it here -->
2225

2326
## Basics
2427

28+
In radically simplified terms, FSD boils down to the following:
29+
30+
- Project partitioning on business domains
31+
- Specific and consistent file structure (see the image below)
32+
2533
![themed--scheme](/img/visual_schema.jpg)
2634

2735
The terms in the diagram above are explained in detail in the [**Abstractions**][refs-basics--abstractions] section.
@@ -108,3 +116,5 @@ import Link from "@docusaurus/Link";
108116
[refs-motivation]: /docs/about/motivation
109117
[refs-architecture]: /docs/concepts/architecture
110118
[refs-examples]: /examples
119+
120+
[refs-clean-architecture]: https://medium.com/codex/clean-architecture-for-dummies-df6561d42c94

0 commit comments

Comments
 (0)