📝
WritingGo

Documentation

by github

Documentation is a Writing skill for Claude Code, published by github in gh-aw.

4.9K stars495 forkson github/gh-awAdded 2026/08/16Repository updated 2026/08/16
actionscaiciclaude-codecodexcopilotgh-extensiongithub-actions
Install in seconds
Install Documentation
Copy Documentation into your Claude Code skills folder. Run the command in your terminal, or review the source on GitHub before installing.
terminal
npx degit https://github.com/github/gh-aw/tree/main/.github/skills/documentation ~/.claude/skills/documentation

Requires Node.js. Downloads this skill only — not the rest of the repository — into your Claude Code skills folder.

Without Node.js

git clone https://github.com/github/gh-aw.git

Clones the whole repository, then copy the skill’s own directory into your skills folder yourself.

In this catalog

Source file
.github/skills/documentation/SKILL.md in github/gh-aw
Installs to
~/.claude/skills/documentation
Collection
One of 25 skills cataloged from this repository
Category
Writing1012 skills

What Documentation does

Documentation provides guidance for writing concise Diátaxis docs for gh-aw with Starlight markdown conventions. Use it when authoring tutorials, how-to guides, reference, and explanation pages.

Documentation is cataloged under Writing on DirSkills. Documentation comes from a repository tagged actions, cai, ci, claude-code and codex.

Documentation

README

Documentation

Documentation lives in docs/, uses GitHub-flavored Markdown, renders with Astro Starlight, and follows Diátaxis.

Diátaxis Framework

Organize documentation into four Diátaxis types:

1. Tutorials (Learning-Oriented)

Purpose: Guide beginners through achieving a specific outcome to build confidence.

  • Start with what the user will build or achieve
  • Provide a clear, step-by-step path from start to finish
  • Include concrete examples and working code
  • Assume minimal prior knowledge
  • Focus on the happy path (avoid edge cases and alternatives)
  • End with a working result the user can see and use
  • Use imperative mood: "Create a file", "Run the command"

Avoid: Explaining concepts in depth, multiple options, troubleshooting

This is the opening of the README. Read the full README on GitHub.

Frequently asked about Documentation

  • What else does github publish alongside Documentation?

    Documentation is one of 25 skills that DirSkills catalogs from github/gh-aw, the repository it ships in. Its siblings there include AWF Release Integrator, Agent Session CLI and Agent Task CLI. Each one is a separate skill with its own page in this directory, installs the same way Documentation does, and is maintained by github in that same repository. The rest of the collection is listed on the github/gh-aw page.

  • How does Documentation compare to other Writing skills?

    Documentation ranks #152 by stars among the 1012 Writing skills in this catalog. The most-starred ones next to it are Article Writing, Social Media Content Calendar and Knowledge Comic Creator. DirSkills ranks by the star count of the repository each skill ships in, so that order reflects how popular those repositories are rather than any review of Documentation against them. Open each page to compare what they document and how they install.

More from github/gh-aw

Documentation is one of 25 skills cataloged on DirSkills from github/gh-aw.

See all 25 skills
🔄
2w ago

AWF Release Integrator

AWF Release Integrator upgrades gh-aw to the latest gh-aw-firewall release, bumps version constants, rebuilds generated artifacts, and reviews upstream spec changes to identify follow-up tasks.
DevOps
4.9K495
🤖
2w ago

Agent Session CLI

Agent Session CLI uses the gh agent-session command to inspect and manage GitHub Copilot coding agent sessions, including creating tasks from natural language instructions, listing, viewing, and updating them.
AI Engineering
4.9K495
🤖
2w ago

Agent Task CLI

Agent Task CLI creates GitHub Copilot coding agent tasks from the command line, using natural language instructions that trigger automated code changes and pull requests. Use it to delegate coding work, list and view tasks, and integrate with GitHub Agentic Workflows.
AI Engineering
4.9K495
🤖
2w ago

Agentic Workflows

Agentic Workflows compiles Markdown-defined AI agent jobs into GitHub Actions, so developers can define AI-powered repository automation and run AI agents securely through GitHub Actions for reasoning tasks.
DevOps
4.9K495
🔀
2w ago

Agentic Workflows Router

Agentic Workflows Router dispatches user requests to design, create, update, debug, or upgrade GitHub Agentic Workflows to the correct internal prompt or skill file. Use it when working on agentic workflows in a repository, and follow the matched instructions directly.
AI Engineering
4.9K495
🔍
2w ago

Checkout Credential Review

Checkout Credential Review helps review code that performs git or gh operations against repository checkouts, ensuring the right credentials are available at the right time and that sparseness, shallowness, and credential-free factors are considered.
Quality
4.9K495