website
website copied to clipboard
Some ideas for refactoring the Flavors doc
What information needs to be added?
https://docs.flutter.dev/deployment/flavors
After an initial look, these ideas might help folks navigate the page and find what they are looking for quickly.
-
Consider a different page title (see below), one that is more literal
-
Move the "what is this doc" summary to the very top of the doc
-
Re-organize the doc based on target platform: iOS, macOS, and Android.
-
High level feedback is "flavors" is a term that might be Flutter-only ? So, when people are initially searching for a solution, their problem articulation might be something like "how do I make different configurations of my flutter app?" or "how do I create different build configurations?". Consider what a developer might literally search for, and then use that for the title of the page. I'm going to guess that anyone new to Flutter might not search for "how do I make a different flavor of my app?", but of course I could be wrong. The suggestion here is to find a more literally worded version of the page title, to juice it's SEO and more quickly be seen as relevant to the developer.
-
This summary is excellent: "This document guides you through setting up Flutter flavors for iOS, macOS, and Android." but it's after many paragraphs of "what are flavors?". Consider a version of that sentence and move it to the very top of the doc. Within 10 seconds, a developer should be able to tell what this doc is helping them solve. A version of this sentence might be "This document guides you through setting up build configurations (called flavors in Flutter) for Flutter apps targeting iOS, macOS, and Android."
-
For example, some specific ideas: move "Environment setup" to each platform. Right now, under Environment setup, I see "Xcode installed". However, that's not relevant if you are not targeting Apple platforms. We could move various platform-specific environment setup instructions under each platform's header in the doc. In addition, I see "Creating flavors for iOS and macOS" and "Using flavors for iOS and macOS" at the same header level (h2). Consider a header structure such as:
- iOS and macOS
-
- Environment setup
-
- Creating
-
- Using
etc
Where should this new content appear?
No response
I would like to fix this problem.
- [ ] I will try and fix this problem on docs.flutter.dev.