-
Notifications
You must be signed in to change notification settings - Fork 11
Guided Development Requirements
The purpose of the ‘Guided development platform tool’ is to show the developer how to execute common development tasks for specific SAP scenarios.
For example if you are a CAP or HANA developer, and you want to add a Fiori module and bind it to a service, the 'Guided development' kit shows you in a step-by-step guide, what are the snippets you should add, and which commands or tools you should run to complete your task.
As a platform tool the Guided development kit provides consistent experience for developers who asked to develop different type of scenarios, moreover it wraps specific tools and platform capabilities in one place. Developers for example can find a step-by-step guide for ‘how to bring my application to the cloud’, ‘how to bind a service to my project’, ‘how to add new entity or service’ and so on.
Since the tool has a context awareness, it knows which guide to show and when.
The 'Guided Development' tool opens automatically in a tab editor after the developer creates a new application based on a template using the New Project Wizard tool. It can be also called from the command pallet or from a context menu.
Develop an SAP application with the help of an interactive guide. Provides guidance based on the best practices defined by SAP experts. Provides a set of guides per development scenario (Frontend development, SAP HANA, Workflow, etc.). Each guide helps the developer to complete a development task for a specific SAP scenario. Each guide can point to a dedicated tool that can help with the task implementation (for example, the Snippet tool, the command palette, and others). Requirements Triggers The tool can be triggered from:
Command pallet - 'SAP Business Application Studio: Guided Development Kit'. Context menu in the file explorer, the entry should appear in all dir/file level - 'Guided Development Kit'. Upon predefined request - for example every time the user create new project or add new module. UI component and data hierarchy The tool has a title - 'Guided Development Kit'
The tool has a description - "The ‘Guided development platform Kit’ shows you how to execute common development tasks for specific SAP scenarios in a step-by-step guide, what are the snippets you should add, and which commands or tools you should run to complete your task."
The tool consist of 'Topic' which are semantical group for one or more task.
Each 'Group label' has title and description that were defined by the extension owner. I.g. CAP scenario owner can decide that he/she wants to guide their developers 'how to take their application to the cloud', in this case they create a new collection with this title and description.
Each 'Topic' has one ore more 'Item(s)'.
'Topic' has one or more item(s).
Item consists of: title, description (the UI shows few lines and 'read more'), image and action(s) - 'Apply' - performs the task, use default parameters. 'Open' - execute another tool/command/editor/URL, that should be filled in with the relevant content.
Item can function as a 'parent' of other items. In this case the parent doesn't have an action.
'Parent' item contains one level or more under it, and it can contain one or more items.
Item can function as 'parent' and 'child' at the same time.
Guided development tool has 3 levels of priority for collections/tasks order:
Platform Scenario Extension/Plugin Scenario owner should decide the order of the collections and the tasks in the collection. Moreover, he can combine several tasks that are coming from the extension.
For example:
CAP owner can decide that the first collection is 'Take your application to the cloud" and the second can be "Bind A Service", however if the user installed Fiori extension, the second collection can be "Add a UI component to your app".
The dynamic of the collections should be based on the scenario and the extensions the developer added.
Scenario owner can add/remove collection(s) according to the status of the project. The contributor needs to update the guided list accordingly (for collections or items). i.g post app creation vs. after adding a UI and bind a service.
Tool report per day/week/month: Tool (name/id) Started Ended Usage: Activity per user per day Avg. tool per user Aspects to Consider The solution should be generic and handle the different type of scenarios.
Each tool should be designed according to the UX guidelines. Each tool has its own starting and ending definition.
Documentations, help, Jam page