From 736ef98b6c8afdea074f4e98f2962d4d4b8796ea Mon Sep 17 00:00:00 2001 From: PhilH <philh@PhilHs-MacBook-Air.local> Date: Fri, 7 Aug 2020 12:01:32 +0200 Subject: [PATCH] suggestions regarding tuto intro --- .../How-to-make-components.rst | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/source/import_documentation/How-to-make-components.rst b/source/import_documentation/How-to-make-components.rst index d21e8b3..138e85c 100644 --- a/source/import_documentation/How-to-make-components.rst +++ b/source/import_documentation/How-to-make-components.rst @@ -4,20 +4,15 @@ How to make components When you should make a component ================================= -A component = a functionality (*through human eyes*) +A component is an application service that can be re-used by multiple organizations. You can think about it as an atomic functionality that can be picked and added by people with no technical skills. -Sometime you should wonder if it's relevant to make a component. "It's so simple to code, why make a component ?" +Developers often build components in order to avoid repeating the same piece of code in multiple places. As a developer, you may wonder why you should create a component when you can implement the same functionality with the same amount of code, just by calling the underlying services. For instance, implementing a collaborative FAQ could be done with just *sib-display* and *sib-form*. Encapsulating them within an FAQ component wouldn't make your code more concise. -Keep it in your mind : Component aren't justify by technical optimization issue but by human functional brick identification. +Developing with Startin'Blox is an opportunity to shift your perspective regarding who you program for. Instead of thinking just about your own requirements, you're invited to deliver features useful to both your own project and a much broader ecosystem of organizations. -**You share more than code, you share ideas for collaborative tools.** +**With components, you share more than code, you share resources for collaboration within and between organizations.** -When you are coding an app, think twice : Is there any functionality that could be useful for other organizations? - -Example : ---------- -An FAQ is just a sib-display and maybe a sib-form to make it collaborative. It's not usefull to encapsulate it according to technical considerations. -But FAQ is an excellent onbaording and knowledge management tools. Creating a component is about creating inspiration. +So, when you develop a new feature, think about who could use it. If it can be useful to others and there's no similar component already available, make a component so that your work will be easily accessed and used by many! Let's code ============ -- GitLab