Add comprehensive copilot-instructions.md for Windows Driver Docs DDI repository#1625
Closed
Copilot wants to merge 1 commit into
Closed
Add comprehensive copilot-instructions.md for Windows Driver Docs DDI repository#1625Copilot wants to merge 1 commit into
Copilot wants to merge 1 commit into
Conversation
Copilot
AI
changed the title
[WIP] write a copilot-instructions.md for this repo. scan the repo to write it. also add the following key for the filename prefixes: ne (enum)
nc (callback)
ni (IOCTL)
ns (structure)
nl (class)
nn (interface)
Also include:
You must include the ai-usage m...
Add comprehensive copilot-instructions.md for Windows Driver Docs DDI repository
Aug 21, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a comprehensive
copilot-instructions.mdfile to help developers using GitHub Copilot contribute effectively to the Windows Driver Docs DDI repository.Overview
The new instructions file provides detailed guidance for working with the 25,800+ documentation files in this repository, which document Windows Driver Kit (WDK) Device Driver Interface (DDI) APIs published at learn.microsoft.com/windows-hardware/drivers/ddi.
Key Features
File Naming Convention Reference
Includes a comprehensive table documenting the filename prefixes used throughout the repository:
AI Usage Guidelines
Provides clear requirements for the
ai-usagemetadata attribute that must be included when AI is used to create or revise content:ai-assisted: Content created by human with AI helpai-generated: Content created by AI with human reviewThis metadata automatically adds customer-facing AI disclosure to published content.
Link Format Standards
Establishes the requirement to use site-relative links instead of fully qualified URLs:
/windows-hardware/drivers/ddi/ntifs/nf-ntifs-ccpreparemdlwritelearn.microsoft.com/windows-hardware/drivers/ddi/ntifs/nf-ntifs-ccpreparemdlwriteContent Structure Guidance
Documents the standard YAML frontmatter requirements and content sections including:
Repository-Specific Best Practices
Provides practical guidance for maintaining consistency across the large codebase, including technology area classifications, metadata validation, and contribution workflows.
Impact
This documentation will help ensure that AI-assisted contributions to the Windows Driver documentation maintain the high quality and consistency standards required for official Microsoft technical documentation while properly attributing AI usage to readers.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.