Copilot-Skills document-project.instructions.md

Copilot-Skills document-project.instructions.md is an instructions file for GitHub Copilot from TheSethRose/Copilot-Skills. It costs 2,562 tokens per session, scanned A, original, MIT.

Instructions for generating project documentation: written explanations of how a codebase works, how to use it, and how to contribute. They guide an analysis of the repository before creating a structured markdown documentation folder.

In plain words
What is it for?
Analyzing a project's structure, detecting its language and framework, finding existing documentation, proposing useful documents, and creating documentation in a docs folder.
Why use it?
They help turn an unfamiliar codebase into organized documentation and distinguish project documentation from editing PDF or Word files. The process also checks for existing documentation and repository conventions.

Instructions file for GitHub Copilot

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/thesethrose/copilot-skills/document-project
Clone the repo
git clone --depth 1 https://github.com/TheSethRose/Copilot-Skills

Made for: GitHub Copilot.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for Copilot-Skills document-project.instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/thesethrose/copilot-skills/document-project.svg)](https://agentmods.dev/instructions/thesethrose/copilot-skills/document-project)
Your own site
<a href="https://agentmods.dev/instructions/thesethrose/copilot-skills/document-project"><img src="https://agentmods.dev/badge/instructions/thesethrose/copilot-skills/document-project.svg" alt="Measured on agentmods" height="20"></a>
Per session 2,562 This file is loaded in full into every session.
When invoked 2,562 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.02562 $0.02562
Opus 5 $0.01281 $0.01281
Sonnet 5 $0.00512 $0.00512
Haiku 4.5 $0.00256 $0.00256

Measured 3d ago against content hash 7f37bddc2255, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

Copilot-Skills document-project.instructions.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 3d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/instructions/document-project.instructions.md · 469 lines

How it starts

The opening of the file, as written. The whole thing — 469 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Document Project - Instructions

When working with documentation generation or when queries contain "document project", "generate docs", or "documentation", this context activates.

Core Purpose

Generate clear, structured markdown documentation for repositories. Analyze project structure, propose appropriate docs, and build a /docs folder with quality content.

Key Distinction: This skill generates PROJECT DOCUMENTATION (markdown files). For PDF/DOCX/PPTX manipulation, use /pdf-handling.

Default Behaviors

When user mentions "document project" or "generate docs"

  1. Suggest /document-project skill
  2. Analyze current repository structure
  3. Detect project type, language, framework
  4. Propose appropriate documentation set
  5. Confirm before creating files

When user mentions "documentation" in general context

  1. Clarify intent: project docs or file manipulation?
  2. If project docs → use /document-project
  3. If file manipulation (PDF, etc.) → use /pdf-handling

When analyzing a codebase

  1. Run analyze_project.sh to get project metadata
  2. Check for existing documentation
  3. Respect .gitignore patterns
  4. Detect open-source vs closed-source
  5. Propose template based on analysis

When generating documentation

  1. Always use --dry-run first to preview
  2. Show proposed file list to user
  3. Get confirmation before creating files
  4. Create /docs folder if needed
  5. Generate markdown with proper formatting
  6. Validate output with validate_docs.sh
  7. Suggest linking from main README

Quality Guidelines

✅ Do

  • Analyze before proposing documentation
  • Use appropriate template (minimal, standard, open-source)
  • Respect existing documentation (never overwrite without confirmation)
  • Follow markdown best practices
  • Include code examples in appropriate language
  • Validate all generated markdown
  • Respect .gitignore patterns
  • Use consistent tone and formatting
  • Link documentation from main README
  • Suggest conventional Git commit messages

Read the full file on GitHub · 469 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 3d ago First seen · 469 lines · 2,562 tokens per session scan A 7f37bddc2255

Subscribe to this mod's changes

Copilot-Skills document-project.instructions.md is an instructions file published in the GitHub repository TheSethRose/Copilot-Skills (3 stars, last pushed 8mo ago), licensed MIT. It adds 2,562 tokens to every session, about $0.0128 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.