About Spryker Documentation
- Updated on 02 Jul 2020
- 7 minutes to read
Spryker Documentation is a central hub for knowledge and information about the Spryker Commerce OS. It details the aspects involved with setting up and using Spryker for your project.
We try to organize our documentation in such a way that it would be easy to find and utilize for various target users. To achieve this, we do the following:
- Split documentation into documentation for specific target groups and tasks they want to accomplish.
- Separate feature documentation into articles for various personas: Developer, Back-Office User, and Shop User.
- Version documentation according to the product releases. To select a version for a specific product release, choose the version in the green dropdown on the right of each article.
- Use tags to distinct documentation by product versions and help you understand whether the documentation refers to B2B or B2C features.
The Spryker documentation is broken into the following sections:
About: Is for people who are thinking about adopting the Spryker Commerce OS. Here you will find all the information you need to help you make your decision. This section also contains the Spryker release notes, documentation updates, and news.
Features: Contains descriptions of all Spryker features categorized into Capabilities. Feature overview pages contain a list of tasks and articles relevant for Developers, Back Office Users, and Shop Users. See Personas for more information about these target groups.
User Guides: Meant primarily for the end-users who need assistance navigating and using features of the Spryker Back Office and Storefront.
Developer Guides: Meant for the developers and contain instructions on how to install and configure Spryker for your project. This section will also help you understand the technical essentials and concepts of the Spryker Commerce OS.
Glue API: Provides an overview of the Glue Rest API feature resources and general information on the Glue API infrastructure. These guides are meant both for developers and the API users.
Technology Partners: Here, the developers will find the instructions on how to integrate third-party technology partners into your Spryker project.
Migration and Integration: Holds feature integration and module migration guides for the developers.
Tutorials: Contains step-by-step instructions on how to perform all types of technical tasks with the Spryker Commerce OS. This section is meant for developers.
In our documentation, we refer to the following personas:
- Back Office User
- Shop User
We also use these personas to categorize articles related to individual features. See Business on Behalf feature summary page for example.
The table below shows what specific roles each persona includes and what each role is up to:
|Persona||Includes roles||Role description|
|Backend Developer||Their main tasks are the development and update of the backend part for the new and existing features.|
|Frontend Developer||Their main tasks are the development and update of the frontend part for the new and existing features.|
|DevOps||Their main tasks is the upkeep of all business critical systems, especially websites and systems available for public access, making sure all business- critical systems are available, reliable, and work as intended.|
|Back Office User||Spryker Administrator||The Spryker Administrator is responsible fort he entire setup and management of the E-commerce system: stores creation and configuration, payment methods, warehouses setup etc. Most of this work is done in Spryker Back-Office, but they may have to talk to developers in some cases to have things done.|
|Marketing Content Manager||Responsible for managing content in online store and apps to increase sales.|
|Merchant Fulfillment Manager||Responsibilities:
|Fulfillment / Order Manager||Responsibilities:
|Product Catalog Manager||A Category Manager gathers insights about how customers perceive product categories and products by analyzing customer behavior in the frontend. He/she manages prices and promotions for products.|
|Merchant Catalog Manager||Responsibilities:
|Marketplace Administrator||A marketplace operator is a company that offers a platform (online marketplace) to other third parties (merchants: retailers or wholesalers). An online marketplace is a type of e-commerce site where products are delivered and fulfilled by multiple merchants, whereas customer transactions are processed by the marketplace operator. The marketplace operator can have own physical or digital inventory (Amazon, Zalando, Apple) but it is not a must (Ebay, Idealo)|
|DevOps||Their main tasks is the upkeep of all business-critical systems, especially websites and systems available for public access, making sure all business- critical systems are available, reliable, and work as intended.|
|Shop User||B2C Buyer||A person who visits a shop and can buy products/services from it.|
|B2B Buyer||A person (impersonating a Company) buying products/services from a B2B Company.|
Tags help you to easier find documentation which is relevant for you. Tags are displayed on the right of the article, under the Table of Contents.
We use the following tags:
- B2B Shop: Feature/topic in question is applied to B2B Demo Shop.
- B2C Shop: Stands for B2C Demo Shop features / topics.
- Glue API: Signifies that feature is also available in the Spryker Glue API.
- Versions (201811.0, 201903.0, 201907.0 etc.): Indicate what product version(s) the feature described in the document relates to.
Sending your Feedback
We are striving to improve our documentation, make it easier for you to find the necessary articles, and provide you with all the information you need. You can help us with that by sending your comments and suggestions to [email protected]
Your feedback is very important and much valued! Let us know what you think by clicking Yes or No for Was this article helpful? at the end of every article.
Contributing to the Documentation
We at Spryker aim to constantly improve the content we provide our customers and partners with. You can get involved in improving the Spryker documentation by reporting issues and editing documentation via pull requests on GitHub.
To report a documentation issue, do the following:
- On an article page, click Edit or Report under the title of the article.
- In the Spryker documentation GitHub repository, click Issues tab.
- Click New issue on the right.
- Fill in the required information and click Submit issue.
To edit a page directly on GitHub:
- In the right upper corner, select the latest version of documentation. In the drop-down menu, it is always the last one.
- Open the article you want to edit.
- On the article page, click Edit or Report under the title of the article.
- Fork the repository to suggest changes.
You need to fork the repository only the first time you edit the Spryker documentation.
- Click Edit this file in the top right menu and make the changes.
- Once done, write a message explaining what you changed and click Propose file change. You will see a a diff of your changes compared to the current version of the master branch.
- Click Create pull request.
- Click Create pull request again to confirm the creation.
That’s it! Your pull request has been created. Our Documentation team will review it, and once approved, your changes will be merged and available on the documentation website.
All terms and regulations are provided in the Disclaimer.