How to contribute tutorials
This commit is contained in:
Julian Molina committed
1 parent
844d1313c9
commit
4f82fa8125
3 files changed
+349
-25
No files matched your search
@@ -42,8 +42,13 @@
|
||||
},
|
||||
{
|
||||
"style": "Chapter",
|
||||
"text": "VIII->Superalgos->Topic->Order Management->One of the crucial aspects of trading automation is the management of orders. The system operates with assumptions that must be verified and synchronized with the exchange. Learning how the Low-Frequency Trading Bot manages orders will help you understand the life cycle of orders and how your definitions in the Open Stage and the Close Stage affect the results.",
|
||||
"updated": 1611237227549
|
||||
"text": "VIII->Superalgos->Topic->LF Trading Bot Available Data Structures->This chapter describes the three main data structures made available by the Trading Bot.",
|
||||
"updated": 1617708146321
|
||||
},
|
||||
{
|
||||
"style": "Chapter",
|
||||
"text": "IX->Superalgos->Topic->Order Management->One of the crucial aspects of trading automation is the management of orders. The system operates with assumptions that must be verified and synchronized with the exchange. Learning how the Low-Frequency Trading Bot manages orders will help you understand the life cycle of orders and how your definitions in the Open Stage and the Close Stage affect the results.",
|
||||
"updated": 1617708175194
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
@@ -51,8 +56,8 @@
|
||||
},
|
||||
{
|
||||
"style": "Chapter",
|
||||
"text": "IX->Superalgos->Topic->Trading Engine->The trading engine is about making the data processed by the Trading Bot accessible. Use it while debugging strategies to visually track every piece of information processed by the trading bot at any point in time. Use it from within trading systems to feed strategies with the details of what happens at runtime.",
|
||||
"updated": 1611260954268
|
||||
"text": "X->Superalgos->Topic->Trading Engine->The trading engine is about making the data processed by the Trading Bot accessible. Use it while debugging strategies to visually track every piece of information processed by the trading bot at any point in time. Use it from within trading systems to feed strategies with the details of what happens at runtime.",
|
||||
"updated": 1617708180990
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
@@ -60,38 +65,38 @@
|
||||
},
|
||||
{
|
||||
"style": "Chapter",
|
||||
"text": "X->Superalgos->Topic->Trading Farms->Superalgos may coordinate Data Tasks and Trading Tasks across different machines on a network. Trading farms provide a robust environment for smart and scalable deployments.",
|
||||
"updated": 1611503033139
|
||||
"text": "XI->Superalgos->Topic->Trading Farms->Superalgos may coordinate Data Tasks and Trading Tasks across different machines on a network. Trading farms provide a robust environment for smart and scalable deployments.",
|
||||
"updated": 1617708186995
|
||||
},
|
||||
{
|
||||
"style": "Chapter",
|
||||
"text": "XI->Superalgos->Topic->Crypto Ecosystem->The crypto ecosystem manages the interactions with parties external to Superalgos, primarily exchanges. ",
|
||||
"updated": 1611503004599
|
||||
"text": "XII->Superalgos->Topic->Crypto Ecosystem->The crypto ecosystem manages the interactions with parties external to Superalgos, primarily exchanges.",
|
||||
"updated": 1617708192899
|
||||
},
|
||||
{
|
||||
"style": "Chapter",
|
||||
"text": "XII->Superalgos->Topic->Data Mines->Data Mines deal with bots that process data and feature a visual scripting framework that solves most all of the infrastructure intricacies of building indicators and plotters.",
|
||||
"updated": 1611503425133
|
||||
"text": "XIII->Superalgos->Topic->Data Mines->Data Mines deal with bots that process data and feature a visual scripting framework that solves most all of the infrastructure intricacies of building indicators and plotters.",
|
||||
"updated": 1617708198397
|
||||
},
|
||||
{
|
||||
"style": "Chapter",
|
||||
"text": "XIII->Superalgos->Topic->Integrations->Superalgos integrates with Telegram Bots to broadcast announcements emerging from trading sessions. On the other hand, Superalgos supports receiving webhook messages, enabling automated actions originating from messages sent from third-party services, like TradingView.",
|
||||
"updated": 1611503645995
|
||||
"text": "XIV->Superalgos->Topic->Integrations->Superalgos integrates with Telegram Bots to broadcast announcements emerging from trading sessions. On the other hand, Superalgos supports receiving webhook messages, enabling automated actions originating from messages sent from third-party services, like TradingView.",
|
||||
"updated": 1617708209659
|
||||
},
|
||||
{
|
||||
"style": "Chapter",
|
||||
"text": "XIV->Superalgos->Topic->Productivity Tools->This chapter discusses a collection of tools that help optimize productivity.",
|
||||
"updated": 1611503697142
|
||||
"text": "XV->Superalgos->Topic->Productivity Tools->This chapter discusses a collection of tools that help optimize productivity.",
|
||||
"updated": 1617708217018
|
||||
},
|
||||
{
|
||||
"style": "Chapter",
|
||||
"text": "XV->Superalgos->Topic->Troubleshooting->Superalgos is a vast system and you will run into confusing situations while learning it. You must acquire the knowledge on how to analyze the issues that you may encounter. There usually is a good explanation for what is going on. This chapter helps you in that process.",
|
||||
"updated": 1611649840313
|
||||
"text": "XVI->Superalgos->Topic->Troubleshooting->Superalgos is a vast system and you will run into confusing situations while learning it. You must acquire the knowledge on how to analyze the issues that you may encounter. There usually is a good explanation for what is going on. This chapter helps you in that process.",
|
||||
"updated": 1617708223623
|
||||
},
|
||||
{
|
||||
"style": "Chapter",
|
||||
"text": "XVI->Superalgos->Topic->Contributing to Superalgos->Superalgos is a Community project. Everything you build with Superalgos is susceptible to be contributed to the project. Contributing to the project earns you Superalgos (SA) tokens! This chapter covers how you may contribute some of the intelligence you build for yourself, and also how you may get involved with the project at a deeper level.",
|
||||
"updated": 1617094031124
|
||||
"text": "XVII->Superalgos->Topic->Contributing to Superalgos->Superalgos is a Community project. Everything you build with Superalgos is susceptible to be contributed to the project. Contributing to the project earns you Superalgos (SA) tokens! This chapter covers how you may contribute some of the intelligence you build for yourself, and also how you may get involved with the project at a deeper level.",
|
||||
"updated": 1617708229948
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
|
||||
@@ -56,7 +56,8 @@
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Setting up a reference to a time machine node in the charting space hierarchy while using the below parameter causes the following:"
|
||||
"text": "Setting up a reference to a time machine node in the Charting Space hierarchy while using the below parameter causes the following:",
|
||||
"updated": 1617706853889
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
@@ -81,7 +82,8 @@
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Setting up a reference to a time machine node in the charting space hierarchy and using the below parameters allows simulating the pressing of relevant key combinations when on a time machine."
|
||||
"text": "Setting up a reference to a time machine node in the charting space hierarchy and using the below parameters allows replicating the pressing of relevant key combinations when on a time machine.",
|
||||
"updated": 1617706916777
|
||||
},
|
||||
{
|
||||
"style": "Javascript",
|
||||
@@ -103,17 +105,22 @@
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "The batchConfigChangesReferenceParent parameter allows you to edit the configuration of a referenced node and their offspring.",
|
||||
"updated": 1613846892311
|
||||
"text": "The batchConfigChangesReferenceParent property allows you to edit the configuration of a referenced node and their offspring.",
|
||||
"updated": 1617707009812
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "The example below changes the configuration of the three different scale nodes under a time machine. In this case, the time machine is the node referenced, the nodePath is the path of the node whose configuration must be changed relative to the referenceParent, and the properties parameter is the actual configuration to be set."
|
||||
},
|
||||
{
|
||||
"style": "Javascript",
|
||||
"text": " \"batchConfigChangesReferenceParent\": [\n {\n \"nodePath\": \"referenceParent.timeScale\",\n \"properties\": {\n \"autoMinScale\": false,\n \"autoMaxScale\": false,\n \"fromDate\": \"2020-08-31T23:40:00.000Z\",\n \"toDate\": \"2020-09-01T01:00:00.000Z\"\n }\n },\n {\n \"nodePath\": \"referenceParent.rateScale\",\n \"properties\": {\n \"autoMinScale\": false,\n \"autoMaxScale\": false,\n \"minValue\": 11400,\n \"maxValue\": 11800\n }\n },\n {\n \"nodePath\": \"referenceParent.timeFrameScale\",\n \"properties\": {\n \"value\": \"01-min\"\n }\n }\n ]",
|
||||
"updated": 1613846829780
|
||||
"style": "Json",
|
||||
"text": "\"batchConfigChangesReferenceParent\": [\n {\n \"nodePath\": \"referenceParent.timeScale\",\n \"properties\": {\n \"autoMinScale\": false,\n \"autoMaxScale\": false,\n \"fromDate\": \"2020-08-31T23:40:00.000Z\",\n \"toDate\": \"2020-09-01T01:00:00.000Z\"\n }\n },\n {\n \"nodePath\": \"referenceParent.rateScale\",\n \"properties\": {\n \"autoMinScale\": false,\n \"autoMaxScale\": false,\n \"minValue\": 11400,\n \"maxValue\": 11800\n }\n },\n {\n \"nodePath\": \"referenceParent.timeFrameScale\",\n \"properties\": {\n \"value\": \"01-min\"\n }\n }\n ]",
|
||||
"updated": 1617707082553
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
"text": "A typical use case for this resource is when you wish to bring to user to a specific point in a chart, but it may be used for any other case that requires manipulating node's configurations.",
|
||||
"updated": 1617707174287
|
||||
}
|
||||
]
|
||||
}
|
||||
+312
@@ -0,0 +1,312 @@
|
||||
{
|
||||
"topic": "Contributing to Superalgos",
|
||||
"pageNumber": "6",
|
||||
"type": "How to Contribute Tutorials",
|
||||
"definition": {
|
||||
"text": "Tutorials are the ultimate educational resource available in Superalgos, and they play a crucial role during the onboarding of new users. Contributing tutorials is a great way to help the project grow the user base and is highly appreciated!",
|
||||
"updated": 1617710488028
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "This page discusses best practices to build and contribute Superalgos tutorials. It doesn't cover the actual mechanics of building tutorials. Instead, it focuses on what is desirable.",
|
||||
"updated": 1617732597782
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "The Quest for Quality",
|
||||
"updated": 1617710819169
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "At Superalgos, we take pride in the quality of the product we are building. Documentation and tutorials are crucial parts of Superalgos.",
|
||||
"updated": 1617732636344
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "That said, we understand that it takes time and effort to get to a quality product, thus iterating on early prototypes and implementing early-stage feedback is a good way to achieve the desired quality standards.",
|
||||
"updated": 1617732666027
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
"text": "When you build a tutorial for Superalgos, you become the maintainer of the tutorial. It is your responsibility to keep the tutorial up to date with the system, and to implement the feedback users may share! Your tutorial must become the ultimate resource to learn the topics it covers.",
|
||||
"updated": 1617712109958
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "The Associated Workspace",
|
||||
"updated": 1617712309440
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "To deliver the best possible experience, a tutorial must be featured in a specific Workspace, and the workspace must be custom-tailored to serve the tutorial. The workspace must be clean and feature the assets required for the learning experience to be optimal. It is best to keep the workspace clean, light, and stripped of unnecessary resources.",
|
||||
"updated": 1617732813825
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Tutorial Series & Planning",
|
||||
"updated": 1617712970783
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Some topics are broad, have ramifications, or require a nuanced analysis to be covered thoroughly. In such cases, planning for a series of tutorials is ideal.",
|
||||
"updated": 1617712578718
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Take, for example, the series of tutorials in the Trading System Design Tutorials Plugin Workspace:",
|
||||
"updated": 1617712745906
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "The first tutorial in the series gives a broad introduction to the topic, mostly in conceptual terms. This allows users to see the big picture and learn how the concepts are structured and why they are structured the way they are."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "The second tutorial in the series proposes an exercise that takes several more tutorials to develop and implement. That is, the tutorial sets the basis for what the series will cover.",
|
||||
"updated": 1617732839409
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "The remaining tutorials in the series dissect the exercise proposed earlier and cover with a fine level of detail the implementation. At the same time, they cover all the context and many lateral topics.",
|
||||
"updated": 1617732881797
|
||||
},
|
||||
{
|
||||
"style": "Note",
|
||||
"text": "The whole series threads a common theme and develops it from the simplest to the most complex concepts, step by step. A tutorial series must be exhaustive and eventually, cover the whole topic. It must become the ultimate tool to learn about the subject matter!",
|
||||
"updated": 1617732933799
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "The Target Audience",
|
||||
"updated": 1617713465981
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "People are different. We all have slightly different wirings in our heads, and we all learn differently. In that sense, building tutorials is a bit of a challenge. Some people like tutorials that go straight to the point and show them how to solve a very specific issue. Others prefer tutorials that get to the bone, explain every detail, and properly cover the context.",
|
||||
"updated": 1617733011186
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "At this early stage, we can't afford to duplicate efforts and build different tutorials for different kinds of learners. We have to choose the method that best serves the project.",
|
||||
"updated": 1617714108723
|
||||
},
|
||||
{
|
||||
"style": "Important",
|
||||
"text": "We choose to focus on building comprehensive tutorials that everyone can follow and that leaves no one behind. We believe that a tutorial that goes slow, covering every detail, and taking the time to explain the nuance is the right approach at this stage. By building tutorials in a such manner, we guarantee that those who are willing to invest the time to learn the system have adequate material to quickly become power users.",
|
||||
"updated": 1617733086141
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Such tutorials may be slightly annoying to fast-learners, or to people that just want a specific question answered. But such needs are already covered by the searchable knowledge base comprised in the Docs.",
|
||||
"updated": 1617714293925
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Communication Resources",
|
||||
"updated": 1617720397017
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Let's get into some of the specifics on building tutorials for Superalgos!",
|
||||
"updated": 1617720149756
|
||||
},
|
||||
{
|
||||
"style": "Callout",
|
||||
"text": "Superalgos tutorials have evolved through several months worth of feedback from early adopters. We feel we have found a sweet spot, and have started to develop a style in the way we use the space available in each tutorial step. The following are some notes that will help you build tutorials that match the format of existing tutorials.",
|
||||
"updated": 1617733117832
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "One Call For Action Only"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Each tutorial step should have a single call for action, that is, a single instruction that the user must carry out. This is the ideal case scenario. There may be exceptions, for example, when we ask the user to read a page in the Docs and do something else as the main instruction. ",
|
||||
"updated": 1617720707328
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
"text": "In general terms and when possible, try to avoid giving the user more than one task on the same step. Instead, if you expect the user to perform several sequential actions, try to split the process into more than one step — as many as it takes.",
|
||||
"updated": 1617721156206
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "Consistent Use of Styles and Space",
|
||||
"updated": 1617722131538
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Use the different sections on the page and the different paragraph styles for consistent purposes. This helps users get accustomed to a certain format so that they know what to expect from each section of the page. Consistency in the way the information is delivered makes tutorials more usable!",
|
||||
"updated": 1617733162806
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Consider the following:",
|
||||
"updated": 1617722201424
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "The definition box is the space to the right of the icon, below the title. Use this space to introduce what the step is about, that is, to set up the story the step will tell, or to provide some basic context.",
|
||||
"updated": 1617721881227
|
||||
},
|
||||
{
|
||||
"style": "Callout",
|
||||
"text": "The most important section on any given step is the call for action, that is, the instruction that the user must follow to progress in the tutorial. Many times users redo tutorials or go back a few steps just to make sure they did everything right. Always use the callout style — the one applied to this paragraph — for the call for action! Similarly, try to avoid using this style for anything else. If the particular step doesn't have a call for action, then the step should not feature this style at all!",
|
||||
"updated": 1617733181730
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "In some cases, you may need the user to take a very simple action so that the main call for action may be delivered. In such cases, you may use the definition box to tell the user how to get ready to execute the call for action delivered later in the page.",
|
||||
"updated": 1617722090611
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Use the rest of the styes to develop the content."
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "Use of Docs Pages"
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "When you need the user to learn about a specific concept to get the proper context on the subject, do not replicate in the tutorial information that exists in the Docs. Duplicating information is not a good idea, as it makes it harder to maintain the Docs and tutorials.",
|
||||
"updated": 1617730695174
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
"text": "Asking the user to read a page or a section of a page in the Docs is the correct approach. This has the added benefit of making the user aware that the Docs cover the topic too.",
|
||||
"updated": 1617724009821
|
||||
},
|
||||
{
|
||||
"style": "Important",
|
||||
"text": "If you find that the relevant page in the Docs is outdated, doesn't cover the topic with the appropriate depth, or maybe even doesn't exist, helping create, complete, and/or improve the delivery of the information in the Docs is just as valuable as building the tutorial! Long format explanations do not fit well in tutorials. They do fit well in the Docs!",
|
||||
"updated": 1617733203373
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "Interactivity",
|
||||
"updated": 1617724494717
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "The whole point of tutorials — and the main difference with the Docs as learning material — is that they offer the opportunity for hands-on learning. Tutorials are interactive while the Docs are less so!",
|
||||
"updated": 1617730782624
|
||||
},
|
||||
{
|
||||
"style": "Callout",
|
||||
"text": "Make sure you use this quality to the fullest, but also try to maintain a certain balance!",
|
||||
"updated": 1617725782977
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "If the tutorial is talking about a hierarchy, a group of nodes, or a particular node, make sure that the tutorial step takes you to that place in the Workspace. This adds a visual element to the explanation and helps the user get familiar with the data structures involved.",
|
||||
"updated": 1617725808080
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Tutorials can affect the Workspace in many ways replicating actions the user may do. When you want the user to learn to do something, it's best to ask the user to do it, instead of having the tutorial do it for the user.",
|
||||
"updated": 1617733271488
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "On the other hand, the tutorial should take care of doing certain things that are not conducive to learning something relevant to the context of the tutorial. Performing these actions directly may help keep the user focused on what matters most.",
|
||||
"updated": 1617733297397
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "Tooltips",
|
||||
"updated": 1617731886888
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "The system recognizes the name of all entities that have a Docs Page when the name of the entity is written in title case. When that happens, the system automatically creates a tooltip for the phrase. This is a valuable resource, as it provides context that you don't need to explain.",
|
||||
"updated": 1617731953773
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Make sure you use this resource wisely, as too many tooltips on a single tutorial page may be overwhelming, and probably irrelevant."
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
"text": "When you believe the tooltip is relevant, then write the name of the entity in title case. If the tooltip is not relevant, then write the name of the entity in lower case.",
|
||||
"updated": 1617733407351
|
||||
},
|
||||
{
|
||||
"style": "Subtitle",
|
||||
"text": "Naming of Nodes",
|
||||
"updated": 1617731585276
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Superalgos is a complex system. Helping users develop good organizational habits is highly desirable. The more top-level users we may help form, the more powerful the project becomes.",
|
||||
"updated": 1617732614881
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "When users create new data structures, it's good practice to have them name the relevant nodes. This is particularly important with nodes that pass on their names through references to other nodes.",
|
||||
"updated": 1617733435330
|
||||
},
|
||||
{
|
||||
"style": "Note",
|
||||
"text": "Make sure your tutorial goes the extra mile and reminds users to name those kinds of nodes. Proposing a specific name is ideal. Remember that the user may not know what comes next or what the node is used for at the time of creation, so they may not know what a relevant name may be. But you do, so you may propose a name that is consistent with the tutorial's goal.",
|
||||
"updated": 1617731598259
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
"text": "Look & Feel",
|
||||
"updated": 1617722154194
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": ""
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "There is a philosophical debate on whether beauty is objective or subjective. Some people think beauty is in the eyes of the beholder, while others believe that there are inherently beautiful things.",
|
||||
"updated": 1617733474625
|
||||
},
|
||||
{
|
||||
"style": "Callout",
|
||||
"text": "Whatever the case may be, we want the overall look & feel of tutorials to be consistent!",
|
||||
"updated": 1617733495986
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Here's a list of requirements that help tutorials be consistent in their look & feel:",
|
||||
"updated": 1617722868882
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Always use proper title case for titles.",
|
||||
"updated": 1617722923539
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Titles look best when they span a single line. Use two-line titles only if strictly necessary!"
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Always use an icon to illustrate the step. Sometimes the appropriate icon is the one corresponding to the node the user is working with. Other times you may use icons figuratively, playing with alternate meanings of what the drawing may represent."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Avoid stud step pages. Steps with very little content seem empty and feel strange. You don't need to feel the space with gibberish or unnecessary information. Instead, try to use the space to provide context for the call for action. Explain why the user is asked to do this or that. Let the user know what may be expected from the action and so on.",
|
||||
"updated": 1617733584684
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "As a corollary of the above, the opposite case may be problematic too. That is, when the content barely fits the page and gets too close to the row of buttons fixed at the bottom of each step. The problem is that some browsers / OS combinations render styles slightly differently, and what may seem close to the buttons in one system may overlap the buttons in the next. Try to level at least one full empty line — preferably two.",
|
||||
"updated": 1617733668851
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Do not set two consecutive paragraphs with the same style. The only exception is for bullet lists. Even the Docs Text Style is not formated to look good as consecutive paragraphs in the context of a tutorial (there is no padding between paragraphs).",
|
||||
"updated": 1617723650896
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": ""
|
||||
}
|
||||
]
|
||||
}
|
||||
Reference in new issue
Block a user