Thank you for your initiative and willingness to create a theory article for Hyperskill! Please, take this task responsibly: texts you create may be published on the site and seen by other students. We've gathered recommendations for a perfect theory article:
Content & style
- Try to write in an engaging manner, and avoid a documentation-like style.
- Explain the concepts clearly, as if for a complete beginner in the topic, use straightforward and detailed explanations.
- Give concrete real-world examples, and describe situations where the student is likely to use that specific skill.
- Stick to B2-oriented English, and proofread your text before publishing it.
Structure
- Start the text with a short introduction that introduces the topic and motivates the student to keep reading.
- Pack the main content into 3-5 main sections, focusing each on one major aspect.
- End the text with a Conclusion section with a short resume of the main terms and points of the topic.
- Add visual components (alert, code snippet, image) to alternate with the text and make it easier to read.
- Make sure your text can be read in 7-12 minutes.
Formatting
- Format section titles as Headings.
- Use bold to highlight new and important terms and italics for folder/file names, a path to a file, or a URL.
- To mark programming expressions (types, classes, operators, etc.), use the Code style. If you want to insert an entire code snippet, use the option "Code block" located on the toolbar.
- Feel free to add appropriate pictures to illustrate your point via the option “Image” from the toolbar. Please, also provide the alternative text (alt) to all images!
- To emphasize important information in the text, you can also use alerts. A text enclosed in the tags [ALERT-primary] .. [/ALERT] will appear on a blue background, and the one in the tags [ALERT-warning]..[/ALERT] on the yellow background.