Terminology Guide for Documentation

This guide establishes consistent terminology for the WRK541 workshop documentation to ensure clarity and professionalism.

Official Product Names

Always Use Full Names on First Reference

GitHub Copilot : Use the full name "GitHub Copilot" on first mention in each document, then "Copilot" for subsequent references. : ✅ Correct: "GitHub Copilot helps you write code. Copilot uses AI..." : ❌ Incorrect: "Copilot helps you write code" (on first mention)

ASP.NET Core Minimal APIs : Always capitalize "ASP.NET Core" and "Minimal APIs" : ✅ Correct: "ASP.NET Core Minimal APIs" : ❌ Incorrect: "Asp.net core minimal apis" or "minimal API"

FastAPI : Write as one word with capital F and API : ✅ Correct: "FastAPI" : ❌ Incorrect: "Fast API" or "fast-api"

.NET : Always include the period before NET and use capital letters : ✅ Correct: ".NET 10" or ".NET SDK" : ❌ Incorrect: "dotnet" or "Net" (except when referring to command line tool dotnet)

Visual Studio Code : Use full name on first reference, then "VS Code" : ✅ Correct: "Visual Studio Code" (first use), "VS Code" (subsequent) : ❌ Incorrect: "VSCode" or "Visual Studio" (different product)

Copilot Modes

Always capitalize mode names when referring to specific Copilot features:

• Ask Mode (not "ask mode" or "Ask mode")
• Agent Mode (not "agent mode")
• Plan Mode (not "plan mode")

Example: "Use Agent Mode to scaffold the project" ✅

Framework and Library Names

Python : Always capitalize : ✅ "Python 3.12" : ❌ "python"

C# : Use capital C followed by # symbol : ✅ "C#" : ❌ "c#" or "csharp" (except in file paths)

JSON : Always capitalize all letters : ✅ "JSON file" : ❌ "json" or "Json"

Swagger : Capitalize when referring to the tool : ✅ "Swagger documentation"

OpenAPI : Capitalize both O and API : ✅ "OpenAPI specification" : ❌ "Open API" or "openapi"

Testing Frameworks

pytest : Lowercase, one word : ✅ "pytest" : ❌ "PyTest" or "Pytest"

MSTest : Capital MS followed by capital T : ✅ "MSTest" : ❌ "mstest" or "Ms Test"

File and Code References

Program.cs : Use exact capitalization when referring to the file : ✅ "Program.cs" : ❌ "program.cs" or "Program.CS"

main.py : Use lowercase when referring to the file : ✅ "main.py" : ❌ "Main.py"

weather.json : Use lowercase for data files : ✅ "weather.json"

Technical Terms

API Endpoint : Two words, capitalize when starting a sentence : ✅ "The API endpoint returns weather data" : ❌ "api-endpoint" or "APIEndpoint"

Repository/Repo : Use "repository" in formal documentation, "repo" in casual contexts : ✅ "Clone the repository" (formal) : ✅ "The repo contains..." (casual)

GitHub Codespaces : Two words, both capitalized : ✅ "GitHub Codespaces" : ❌ "Github Codespaces" or "GitHub codespaces"

Port Number : Use "port" when referring to network ports : ✅ "port 8000" : ❌ "Port: 8000" or "PORT 8000" (except in environment variables)

Command Line Tools

dotnet : Lowercase when referring to the command line tool : ✅ "dotnet build" : ❌ "Dotnet build" or "DOTNET build"

git : Lowercase when referring to the command : ✅ "git status" : ❌ "Git status"

pip : Lowercase : ✅ "pip install" : ❌ "PIP install"

Documentation Style

Capitalization in Headings

Use title case for major headings: ✅ "Understanding the Project" ❌ "Understanding The Project" (don't capitalize articles)

Lists and Bullets

• Start each bullet with a capital letter
• End with period if it's a complete sentence
• No period if it's a fragment or single word

Code Blocks

Always specify the language for syntax highlighting:

✅ ```csharp var app = WebApplication.Create(); ```

✅ ```python app = FastAPI() ```

Common Mistakes to Avoid

❌ Incorrect	✅ Correct	Note
Copilot Chat	GitHub Copilot Chat	Use full name first
.Net	.NET	Must be capitalized
Minimal api	Minimal API	Capitalize API
fast api	FastAPI	One word
Github	GitHub	Capital H
VScode	VS Code	Space between
Csharp	C#	Use # symbol

Version Numbers

Always include version numbers when relevant:

✅ "Python 3.12" ✅ ".NET 10" ✅ "VS Code 1.85" ❌ "Python 3" ❌ ".NET"

Platform and OS References

Windows : ✅ "Windows 10/11"

macOS : ✅ "macOS" (lowercase mac, capital OS) : ❌ "MacOS" or "Mac OS"

Linux : ✅ "Linux" or "Ubuntu 20.04"

Summary

Consistent terminology improves: - Professionalism: Proper product names show attention to detail - Clarity: Readers know exactly what you're referring to - Searchability: Correct terms help users find information - Credibility: Proper usage demonstrates expertise

When in doubt, refer to official product documentation for the correct spelling and capitalization.