You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* add ai feature summary to docs
* add ai feature summary generation
* Update docs/platform/feature-flags/features.md
Co-authored-by: Leslie Lau <leslie@taplytics.com>
---------
Co-authored-by: Leslie Lau <leslie@taplytics.com>
Copy file name to clipboardExpand all lines: docs/platform/feature-flags/features.md
+50-51Lines changed: 50 additions & 51 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,10 +3,10 @@ title: Features
3
3
sidebar_position: 1
4
4
---
5
5
6
-
> Features are the main elements that you want to control or experiment with in your application. They can be anything from a new UI element to a backend algorithm.
6
+
> Features are the main elements that you want to control or experiment with in your application. They can be anything from a new UI element to a backend algorithm.
7
7
8
8
:::info
9
-
When creating a Feature in DevCycle, you will be able to choose a [Feature Type](/essentials/feature-types) which will pre-fill some options in the Feature and help kick-start your usage of the Feature.
9
+
When creating a Feature in DevCycle, you will be able to choose a [Feature Type](/essentials/feature-types) which will pre-fill some options in the Feature and help kick-start your usage of the Feature.
10
10
:::
11
11
12
12
---
@@ -15,55 +15,53 @@ When creating a Feature in DevCycle, you will be able to choose a [Feature Type]
15
15
16
16
17
17
18
-
19
18
The Feature List Page is where all of your features can be viewed, edited, and filtered for search. This page will show all features within the current Project. The features list (sorted by created date ascending) has the following columns:
20
19
21
-
| Column| Description |
22
-
|--------|----------------------------|
23
-
| Creator | This will show the icon of the user who created this Feature. |
24
-
| Feature type | The selected type of the Feature. Use this to organize your Features. |
25
-
| Status | The Feature's Current [Status](/platform/feature-flags/status-and-lifecycle). This indicates the Feature's current position in the Development [LifeCycle](/platform/feature-flags/status-and-lifecycle). |
26
-
| Name | The Feature's name. This can be changed at any time by editing the Feature. |
27
-
| Key | This is the feature's Key. Use this key to reference the Feature in the SDKs or APIs. |
28
-
| Environments | This displays which environments have Targeting Enabled. If targeting is enabled in multiple environments for a Feature, you can hover over the tag to see which environments are active.|
29
-
| Tags | Tags are customizable labels that help you categorize Features. |
30
-
| Edit | Click this to edit on the row the Feature. |
| Creator | This will show the icon of the user who created this Feature.|
23
+
| Feature type | The selected type of the Feature. Use this to organize your Features. |
24
+
| Status | The Feature's Current [Status](/platform/feature-flags/status-and-lifecycle). This indicates the Feature's current position in the Development [LifeCycle](/platform/feature-flags/status-and-lifecycle). |
25
+
| Name | The Feature's name. This can be changed at any time by editing the Feature.|
26
+
| Key | This is the feature's Key. Use this key to reference the Feature in the SDKs or APIs.|
27
+
| Environments | This displays which environments have Targeting Enabled. If targeting is enabled in multiple environments for a Feature, you can hover over the tag to see which environments are active.|
28
+
| Tags | Tags are customizable labels that help you categorize Features.|
29
+
| Edit | Click this to edit on the row the Feature.|
31
30
32
-
Use the search input to search by Name, Key, Tag, or Description. The filters can be used to filter by Creator, Status, Type, or [Staleness](/platform/feature-flags/stale-feature-notifications). Each column header can be clicked to sort the column.
31
+
Use the search input to search by Name, Key, Tag, or Description. The filters can be used to filter by Creator, Status, Type, or [Staleness](/platform/feature-flags/stale-feature-notifications). Each column header can be clicked to sort the column.
33
32
34
-
> To view another Project's features, use the Project dropdown on the top of the Dashboard.
33
+
> To view another Project's features, use the Project dropdown on the top of the Dashboard.
35
34
36
35
---
37
36
38
-
39
37
## Creating a New Feature
40
38
41
-
From this page, you can create a Feature Flag by clicking "Create New Feature" or the `+` in the top bar.
39
+
From this page, you can create a Feature Flag by clicking "Create New Feature" or the `+` in the top bar.
42
40
43
41
A screen for deciding your Feature Type will now appear. To read more about the feature types and their uses, read [DevCycle Feature Types](/essentials/feature-types).
44
42
45
43
After choosing a type, the information modal will appear prompting you to enter the following information:
46
44
47
45
-**Feature Name**
48
-
Enter a descriptive feature name.
46
+
Enter a descriptive feature name.
49
47
50
48
-**Feature Key**
51
-
This key is how the feature and its variables will be referenced in code. (A key will be automatically suggested based on the entered name.)
49
+
This key is how the feature and its variables will be referenced in code. (A key will be automatically suggested based on the entered name.)
52
50
53
51
-**Description**
54
-
Optionally, you may choose to provide a detailed description of the feature.
52
+
Optionally, you may choose to provide a detailed description of the feature.
55
53
56
54
-**Tags**
57
-
Tags are customizable labels that help you categorize Features.
55
+
Tags are customizable labels that help you categorize Features.
58
56
59
57
-**Jira Ticket ID(s)**
60
-
If your team has setup the [DevCycle integration for Jira](/integrations/jira), you can link Jira tickets directly to Features within DevCycle, making the feature status easily viewable within Jira.
58
+
If your team has setup the [DevCycle integration for Jira](/integrations/jira), you can link Jira tickets directly to Features within DevCycle, making the feature status easily viewable within Jira.
61
59
62
60
-**Initial Variable Key**
63
-
Initial Variable Key allows you to define an initial variable key that can differ from the new feature key name. As you type in the Feature Name, the feature Key and the Initial Variable Key will mimic whatever input is entered in the Feature Name field formatted in kebab case.
61
+
Initial Variable Key allows you to define an initial variable key that can differ from the new feature key name. As you type in the Feature Name, the feature Key and the Initial Variable Key will mimic whatever input is entered in the Feature Name field formatted in kebab case.
64
62
65
63
-**Initial Variable Type**
66
-
Initial Variable Type allows you to select the type of variable for the initial variable created along with your feature (Boolean, JSON, String, or Number).
64
+
Initial Variable Type allows you to select the type of variable for the initial variable created along with your feature (Boolean, JSON, String, or Number).
67
65
68
66
### Creating a New Feature with a Duplicate Initial Variable Key
69
67
@@ -73,30 +71,29 @@ If a duplicate variable key belonging to an unassociated variable is submitted w
73
71
74
72
If the unassociated variable key submitted is archived, a similar modal will appear with the option to unarchive the variable & re-associate it to the new feature.
75
73
76
-
If you wish to unarchive & re-associate, click on the toggle and click `Yes, Proceed`.
74
+
If you wish to unarchive & re-associate, click on the toggle and click `Yes, Proceed`.
77
75
78
-
The feature will be created along with the newly re-associated variable. The variations and corresponding variable values will be populated depending on the [Feature Type](/platform/feature-flags/features) selected.
76
+
The feature will be created along with the newly re-associated variable. The variations and corresponding variable values will be populated depending on the [Feature Type](/platform/feature-flags/features) selected.
79
77
80
-
If you attempt to use a duplicate variable key belonging to a variable that's associated with an existing feature, the dashboard will return an error.
78
+
If you attempt to use a duplicate variable key belonging to a variable that's associated with an existing feature, the dashboard will return an error.
81
79
82
80
---
83
81
84
82
## Updating a Feature on the Feature Form
85
83
86
-
The Feature form uses a tabbed layout, with **Overview**, **Manage Feature**, **Data & Results**, and **Audit Log** tabs.
84
+
The Feature form uses a tabbed layout, with **Overview**, **Manage Feature**, **Data & Results**, and **Audit Log** tabs.
87
85
88
86
### Feature Overview Tab
89
87
90
88
The **Feature Overview Tab** provides a high-level overview of a Feature’s configuration and recent activity. It is the default view when navigating to a Feature and is intended to help users quickly assess the current state of a Feature without reviewing each section individually.
This section displays the Feature Settings (e.g. name, description, type, Maintainer, tags) and the [Status](/platform/feature-flags/status-and-lifecycle.md) of a Feature.
110
+
This section displays the Feature Settings (e.g. name, description, type, Maintainer, tags) and the [Status](/platform/feature-flags/status-and-lifecycle.md) of a Feature.
114
111
115
-
Feature settings can be changed from the Manage Feature tab, click on the arrow on the upper right corner of the box to navigate to the Settings to edit.
112
+
Feature settings can be changed from the Manage Feature tab, click on the arrow on the upper right corner of the box to navigate to the Settings to edit.
116
113
117
114
#### Feature Summary Markdown Section
118
115
@@ -126,19 +123,25 @@ For security reasons, links and images are not supported in this Markdown sectio
126
123
127
124
The content is editable directly from the Overview Tab by users with **Member-level permissions or higher**, allowing teams to store relevant notes directly alongside the Feature rather than relying on external documentation tools.
128
125
126
+
To make the creation and editing of a useful Feature Summary easier, you also have the option to generate a Summary via AI. Next to the edit button there is a "Generate AI Summary" button that adds the details of your Feature to a prompt and uses AI to pull out relevant details.
127
+
128
+
The goal with the AI generation is to make it easier to create and keep Summaries updated, because a quality Feature Summary helps to keep your team informed of your Feature's purpose, who it's targeting and other important details that may be lost with time.
The Reach section displays a version of the Feature Reach graph. The chart shows the aggregated count of evaluations of ALL variables across ALL environments and ALL SDKS. You can filter the evaluation data for different Environments and time ranges. For more granular filtering, click on the arrow on the top right of the section.
132
137
133
-
The Reach section displays a version of the Feature Reach graph. The chart shows the aggregated count of evaluations of ALL variables across ALL environments and ALL SDKS. You can filter the evaluation data for different Environments and time ranges. For more granular filtering, click on the arrow on the top right of the section.
To support collaboration across tools, a **Resources** section is available on the Overview Tab for adding external links to tools like Notion, GitHub, or Figma. You can add a link along with a title, making it easier for teammates to find supporting context without switching tools.
144
+
To support collaboration across tools, a **Resources** section is available on the Overview Tab for adding external links to tools like Notion, GitHub, or Figma. You can add a link along with a title, making it easier for teammates to find supporting context without switching tools.
A read-only snapshot of all variables associated with the Feature is displayed at the bottom of the Overview Tab. It includes the Variable status indicator, name, type, description, and any applied tags. This allows users to quickly audit how a Feature is structured without navigating to the full Feature form.
156
+
A read-only snapshot of all variables associated with the Feature is displayed at the bottom of the Overview Tab. It includes the Variable status indicator, name, type, description, and any applied tags. This allows users to quickly audit how a Feature is structured without navigating to the full Feature form.
154
157
155
158
---
156
159
@@ -168,44 +171,40 @@ To learn more about each section, explore the following resources:
-[Status and LifeCycle](/platform/feature-flags/status-and-lifecycle.md)
170
173
171
-
172
-
To change the **Feature settings** including name, key, and type, description, tags, and Maintainer, navigate to the bottom of the Manage Feature Tab to the Settings section.
174
+
To change the **Feature settings** including name, key, and type, description, tags, and Maintainer, navigate to the bottom of the Manage Feature Tab to the Settings section.
173
175
174
176
Features can be assigned one or more **Maintainers** to indicate who is responsible for the Feature in the settings panel. By default, the creator of the Feature is set as the initial Maintainer. This is useful for clarifying accountability—for example, assigning both a product manager and a technical lead makes it clear who team members should go to if they have questions about the Feature.
The Data & Results Tab houses the Feature Reach graph and the Experiment Results section. To learn more about this section of the Feature Form, review our [Feature Reach](/platform/feature-flags/variables-and-variations/feature-flag-reach.md) and [Metrics](/platform/experimentation/creating-and-managing-metrics.md) documentation.
182
+
The Data & Results Tab houses the Feature Reach graph and the Experiment Results section. To learn more about this section of the Feature Form, review our [Feature Reach](/platform/feature-flags/variables-and-variations/feature-flag-reach.md) and [Metrics](/platform/experimentation/creating-and-managing-metrics.md) documentation.
The Audit Log tracks all modifications made to a Feature. DevCycle captures the DevCycle user who made the change, a time stamp, and what was modified on each Feature save. For more information, review our [Audit Log](/platform/security-and-guardrails/audit-log.md) documentation.
188
+
The Audit Log tracks all modifications made to a Feature. DevCycle captures the DevCycle user who made the change, a time stamp, and what was modified on each Feature save. For more information, review our [Audit Log](/platform/security-and-guardrails/audit-log.md) documentation.
189
189
190
190
---
191
191
192
192
## Archiving a Feature
193
193
194
-
Archiving is the terminal state for Features that have reached the end of their lifecycle, were never implemented in code, or have become entirely obsolete. See [Status & Lifecyle](/platform/feature-flags/status-and-lifecycle) for more information on how to manage Feature Lifecycles in DevCycle.
194
+
Archiving is the terminal state for Features that have reached the end of their lifecycle, were never implemented in code, or have become entirely obsolete. See [Status & Lifecyle](/platform/feature-flags/status-and-lifecycle) for more information on how to manage Feature Lifecycles in DevCycle.
195
195
196
-
Upon Archive, the Feature is put into a read-only mode, and its Audit Logs are accessible and available for teams to review. All [Variables](/platform/feature-flags/variables-and-variations/variables) will be archived along with the Feature *but* can be re-used and associated to other Features. All Variables in this Feature will begin to serve Default values in code.
196
+
Upon Archive, the Feature is put into a read-only mode, and its Audit Logs are accessible and available for teams to review. All [Variables](/platform/feature-flags/variables-and-variations/variables) will be archived along with the Feature _but_ can be re-used and associated to other Features. All Variables in this Feature will begin to serve Default values in code.
197
197
198
198
This action cannot be undone.
199
199
200
-
To archive a Feature, either navigate to the Status section OR scroll to the very bottom of the Manage Feature tab and click the `Archive` button. You will be prompted to confirm archival of the Feature.
200
+
To archive a Feature, either navigate to the Status section OR scroll to the very bottom of the Manage Feature tab and click the `Archive` button. You will be prompted to confirm archival of the Feature.
201
201
202
202
---
203
203
204
204
## Deleting a Feature
205
205
206
-
We recommended that Feature deletion only be used for mistakes, as deletion permanently removes the Feature, its Variables and its Audit Log from DevCycle.
206
+
We recommended that Feature deletion only be used for mistakes, as deletion permanently removes the Feature, its Variables and its Audit Log from DevCycle.
207
207
208
208
This action cannot be undone.
209
209
210
210
To delete, a feature scroll to the very bottom of the Manage Feature tab and click the red `Delete` button. You will be prompted to confirm deletion.
0 commit comments