-
-
Notifications
You must be signed in to change notification settings - Fork 9
Scope and article types
This page will describe the scope of the Help Center.
- Arduino Docs
- Arduino Store
- Arduino Forum
- How to
- Troubleshooting articles
- Answering common questions
- Project tutorials (use the Project Hub)
- Reference material for code (see the Arduino Reference repo instead)
- Device specifications
This type of article should contain clear, step-by-step instructions on how to achieve a defined outcome, e.g. change a setting, connect a device, etc. It should helpful both for users searching for how to achieve the outcome, as well as troubleshooting for users that are stuck somewhere in the process.
-
When setting the title, omit a leading "How to", e.g. "Enable autocomplete in IDE 2.0". This is more concise and readable, and avoids a large clustering when sorting titles alphabetically.
-
Where appropriate, include screenshots.
This type of article contains a description of some problem a user may encounter, and one or more methods of solving it. It should contain clear step-by-step instructions on solving the problem.
-
If the article concerns an error message, the relevant lines of the message should be included in a code block. Do not use a screenshot of the error message.
-
If several solutions are provided, put the one most likely to solve the problem first.
-
The article title should start with an "If", e.g. "If the IDE does not open".
This article answers a question the user may have. Typically it will be short, with only one or two paragraphs. The title should be in the form of a question, e.g. "What are the credentials for the Arduino SIM card".
This type should not be used for questions about whether some goal can be achieved. Use the "How to" type instead. E.g. "Change the language in the IDE", not "Can the language in the IDE be changed?". Besides being more concise, it communicates to the reader that changing the language is possible, just by reading the title.
This article type can be used for explaining something the user may be unsure about, e.g. "About the device status in IoT Cloud". It can also be used for some broader articles covering several aspects of an issue, e.g. "About the Intro Webinar for CTO Go".