Skip to content
TrustedSkillsbeta
Back to all skills

Documentation Writer

Official
github·vlatest·writing·MIT

Automatically generates clear, concise documentation from code comments and project specifications.

Repository

Install on your platform

Showing Claude Code. One command installs this skill into any of the agents below.

  1. 1

    Run this in your project

    terminal
    $ npx skills add github/awesome-copilot --skill documentation-writer -a claude-code

  2. Uses the open-source skills CLI and needs Node.js. Add -g to install it for your user instead of this project.

What we know about this skill

Publisher

github

Matched to the vendor's own GitHub organisation.

Install target

Live repository

Not pinned. Installing fetches whatever the repository holds at the time you run the command.

No human has reviewed this code. The checks below are a static scan of the files at one commit — nobody has run this skill or judged whether it works. A skill runs with whatever access you give your agent, so read the source before you install it.

Automated safety checks

scanned

This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.

  • Declares what it does: passed

    SKILL.md parses and declares a name and a description.

    SKILL.md exists, its frontmatter parses, and it declares a name and a description.

  • No undeclared network calls: passed

    Makes no network calls.

    Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.

  • No obfuscated payloads: passed

    No encoded or obfuscated payloads.

    No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.

  • No credential access: passed

    Reads no keys, tokens, keychains or credential files.

    Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.

  • No pipe-to-shell installers: passed

    No pipe-to-shell or download-and-run installers.

    No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.

  • Pinned to a commit: passed

    Scanned github/awesome-copilot at 6c4d33b9cf.

    The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.

Commit
6c4d33b9cf
Manifest
skills/documentation-writer/SKILL.md
Scanned
1 file, 46 lines
This is a static scan, not a review. It reads the skill's files; it does not run them, and it cannot tell you whether the skill is any good or whether the code does what its description says. A skill runs with whatever access you give your agent.
What each check looks for →

About this skill

What it does

The documentation-writer skill enables AI agents to generate clear, structured technical documentation for software projects. It can create README files, API references, and user guides based on codebases or project descriptions.

When to use it

  • You need to quickly draft a README file for a new open-source project.
  • Your team requires up-to-date API documentation as part of a release cycle.
  • You want to automate the generation of user manuals from code comments and project structure.

Key capabilities

  • Generates markdown-based documentation
  • Parses code comments and project metadata
  • Supports multiple formats like README, API docs, and tutorials

Example prompts

  • "Write a README for my Python library that includes installation instructions and usage examples."
  • "Generate an API reference from the source code in this repository."
  • "Create a user guide based on the documentation comments in this project."

Tips & gotchas

  • Ensure your codebase has well-documented comments to get the best results.
  • This skill may not handle highly specialized or domain-specific documentation formats without additional configuration.