Skip to content

Commit bb1af4c

Browse files
committed
Add recommendations for definitions
Require definitions for new terms introduced in any article.
1 parent de70f1f commit bb1af4c

1 file changed

Lines changed: 1 addition & 0 deletions

File tree

.github/projects/EverydayCSharp-planFundamentalsRestructuring.prompt.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
- If and only if a feature was first added in one of the last three released versions (C# 12 - 14) mention the first it was first introduced.
1515
- Every article must include a tip near the top that identifies where the article sits in the four-tier content structure (*Get started**Fundamentals**Deep dives**Reference*), describes who it's written for, and routes readers to the right tier based on their experience level (Goal 1).
1616
- Define concepts when they are first introduced. Don't assume readers know what a "type" or "namespace" is before those concepts are covered in the proposed TOC. When defining a concept, link to articles that provide more detail. Definitions are less important for concepts that aren't related to the C# language: Remember the goal for Fundamentals is to teach readers how C# works. While we teach through examples, the libraries and packages used in the examples are less important than the language features being demonstrated. For example, when teaching about collections, it's more important to explain what a collection is and how to use them in C# than to provide an in-depth explanation of `List<T>` vs. `Dictionary<K,V>`.
17+
- Similarly, define all terms that may be unfamiliar to the reader when they are first introduced. Link to articles that provide more detail on these terms. Remember that the audience for Fundamentals articles may not be familiar with all C# terminology, or all compputer science terminology. Provide clear definitions and context.
1718
- Set the `ms.topic` metadata value in each article's YAML front matter to match the article's content type (`overview`, `tutorial`, `concept`, `how-to`, `troubleshooting`, or `reference`).
1819
- After writing content, verify the article's structure, required metadata, and sections against the template for its content type (see the [Include major topic types](EverydayCSharp-ProjectMap.md#include-major-topic-types) table for template links).
1920
- Do not add F1 or helpviewer keywords to Fundamentals articles. When pulling content from the Reference section, remove any F1 or helpviewer keywords.

0 commit comments

Comments
 (0)